API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

Le API regolamentari basate su PSD2 forniscono accesso a determinate informazioni finanziarie come saldi dei conti bancari e transazioni. Tuttavia, esistono altre fonti di informazioni patrimoniali che non sono accessibili attraverso queste API. L'API Wealth Reader estende le informazioni offerte dalle API regolamentari fornendo accesso in tempo reale a fonti patrimoniali aggiuntive in qualsiasi entità mondiale. Esistono altri due documenti correlati che ti aiuteranno a integrare l'API Wealth Reader. Uno è la guida all'integrazione del widget Javascript: https://docs-en.wealthreader.com/ e l'altro è una collezione Postman basata su questa documentazione. Molto importante: Questa definizione API è adattata per i clienti che integrano tramite Widget, quindi alcuni parametri che non sono necessari per questo tipo di integrazione sono stati omessi, come i parametri di autenticazione bancaria, poiché verrà utilizzato un token.

Core

API principale richiesta per integrazioni standard

Recupera gli attivi finanziari e i dettagli della loro composizione

Recupera gli attivi finanziari e i dettagli della loro composizione inclusi portafogli di investimento composti da azioni o fondi, carte di credito, assicurazioni e prestiti. Include informazioni di proprietà per ciascun attivo nonché identificatori unici che facilitano l'elaborazione dei dati. È possibile ottenere dati Mock. Verifica con il team tecnico come farlo.

Request Body schema: application/x-www-form-urlencoded
api_key
string

Identifies the client in the service

code
string

Name of the entity. The complete list is available with GET

token
string

Identifies the custodied credential. The flow by which the token has been obtained is described in the 'Widget Integration Guide' document. The following Mock users are available: MOCKDATA, OK response; MOCKOTP, response with OTP challenge; MOCKLOGINKO, response with login error

product_types
string
Enum: "accounts" "portfolios" "cards" "receipts" "loans" "factoring" "confirming" "properties" "invoices" "files"

List of product types from which information is to be retrieved. Accepts multiple values separated by commas.

only_balances
boolean
Default: false

Indicates whether to obtain only the balances of the products instead of all available information. Default value: false.

date_from
string <date>

Date from which transactions are requested, in YYYY-MM-DD format. Must be a date before today.

date_to
string <date>

This only applies to restricting by future dates for products loan and confirming, in YYYY-MM-DD format. The date must be later than today

required_products_schema
string

Required products schema. Indicates the accounts or cards from which data is desired, with additional configurations.

add_pdf_from_uuids
string

Accepts transaction uuids separated by commas. Parameter that is only taken into account if product_types is ALL or includes accounts. Adds the PDF document associated with each of the requested bank transactions.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Elenco dei tipi di transazione

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Interroga i token associati a una api_key

Usa questo metodo per interrogare tutti i token collegati a una specifica api_key. I risultati vengono restituiti in blocchi di 500 token per pagina.

Request Body schema: application/x-www-form-urlencoded
required
api_key
string

api_key to identify the client in the service

page
number

Specify the page number you want to retrieve. Each page contains up to 500 tokens. If not provided, the default value is 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Revocare un token

Questo metodo consente di revocare un token esistente per deautorizzare le future richieste di accesso all'API.

Request Body schema: application/x-www-form-urlencoded
required
api_key
string

Identifies the client in the service

token
string

Token to be revoked.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully revoked."
}

Riassegnare un token a un api_key diverso

Questo metodo consente di riassegnare un token da un api_key a un altro.

Request Body schema: application/x-www-form-urlencoded
required
api_key_source
string

api_key from which to reassign the token.

api_key_target
string

api_key to which to reassign the token.

token
string

Token to be reassigned.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully reassigned."
}

Aggiungere un nuovo dominio

Aggiunge l'associazione tra il dominio che ospiterà il widget e il webhook di destinazione. Per motivi di sicurezza, le operazioni di modifica ed eliminazione sono possibili solo richiedendole al supporto

Request Body schema: application/x-www-form-urlencoded
required
method
required
string

Method to execute.

api_key
required
string

User's API key.

domain
required
string

Domain to add.

url_callback
required
string

URL for callback.

tokenize
required
string

Indicates whether to tokenize or not.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string"
}

Elenco dei codici di errore

Elenco dei codici di errore. Presta particolare attenzione al fatto che non tutti i codici di errore devono ricevere lo stesso trattamento dalla tua applicazione. Per un errore di password errata, non dovresti ritentare la chiamata con gli stessi parametri, ma per un errore che indica che l'entità è in manutenzione, puoi riprovare. Richiedi una sessione tecnica con il nostro team per risolvere qualsiasi domanda sulla gestione degli errori.

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Elenco dei codici di avviso

Elenco dei codici di avviso.

query Parameters
lang
string
Default: "es"
Enum: "es" "en"

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Endpoint opzionali non richiesti per integrazioni standard. Utilizzare solo se esplicitamente indicato da Wealth Reader.

Recupera l'elenco delle entità supportate

Recupera l'elenco delle entità supportate e le informazioni necessarie per disegnare il modulo di accesso dell'entità.

query Parameters
show_only_tested
integer
Default: 0
Enum: 0 1

Indicates whether to show only tested entities. Default value is 0. In production environments, always use 1.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Verificare la titolarità del conto bancario tramite IBAN

Questo endpoint è opzionale e non richiesto per le integrazioni standard. Utilizzare solo se esplicitamente indicato da Wealth Reader. Permette di verificare se una persona fisica o giuridica è titolare di uno specifico conto bancario utilizzando l'IBAN e i dati identificativi del presunto titolare.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Identifies the client in the service

iban
required
string

IBAN code of the bank account to verify (without spaces)

document_type
required
string
Enum: "NIF" "NIE" "Pasaporte" "CIF"

Type of identification document

document_number
required
string

Identification document number

holder_name
required
string

Full name of the natural person or company name

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "result": {
    },
  • "statistics": {
    }
}

Registrare un nuovo utente

Questo endpoint è opzionale e non richiesto per le integrazioni standard. Utilizzare solo se esplicitamente indicato da Wealth Reader. Questo endpoint consente di registrare un utente sulla piattaforma di trasferimento portafoglio Easytransfer o sullo strumento di reporting Acumulas, basato su un identificatore unico.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

service
required
string
Enum: "integra" "easy-transfer"

Service associated with the user. Determines the data flow.

email
required
string <email>

User email, used according to service type.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User registered successfully"
}

Verificare lo stato di registrazione dell'utente

Questo endpoint è opzionale e non richiesto per le integrazioni standard. Utilizzare solo se esplicitamente indicato da Wealth Reader. Verifica se un utente è registrato nel sistema Easytransfer o Acumulas e restituisce il link di accesso unico per l'utente.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key

user_id
required
string

User identification document.

Responses

Response samples

Content type
application/json
{}

Revocare un utente precedentemente registrato

Questo endpoint è opzionale e non richiesto per le integrazioni standard. Utilizzare solo se esplicitamente indicato da Wealth Reader. Questo endpoint consente di annullare la registrazione di un utente dal servizio della piattaforma Easytransfer o Acumulas.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string

Authentication key (8 alphanumeric characters)

user_id
required
string

User identification document.

service
required
string
Enum: "integra" "easy-transfer" "all"

Service from which to unregister the user. 'all' for all services.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "User unregistered successfully"
}

Caricamento connessioni batch

Questo endpoint è opzionale e non richiesto per le integrazioni standard. Utilizzare solo se esplicitamente indicato da Wealth Reader. Gli endpoint raggruppati sotto il tag "batch" consentono di elaborare più connessioni bancarie in modo asincrono, a differenza del metodo /entities/ che è sincrono. Ideale per elaborare grandi volumi di connessioni ed evitare timeout.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

notification_url
required
string <uri>

URL where notification will be sent when batch processing finishes

required
Array of objects (batch-connection) non-empty

List of connections to process

Responses

Request samples

Content type
application/json
{
  • "api_key": "12345678",
  • "notification_url": "https://example.com/webhook/batch-complete",
  • "connections": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "total_connections": 5,
  • "estimated_completion_time": "2025-01-20T10:45:00Z"
}

Ottenere statistiche generali sulle connessioni batch

Questo endpoint è opzionale. Recupera statistiche generali sul risultato dell'elaborazione di tutte le connessioni in un batch.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "batch_id": "batch_20250120_a1b2c3d4",
  • "status": "completed",
  • "statistics": {
    }
}

Ottenere il risultato individuale di una connessione specifica all'interno di un batch

Questo endpoint è opzionale. Recupera il risultato di una connessione specifica dal batch.

Request Body schema: application/json
required
api_key
required
string

Identifies the client in the service

batch_id
required
string

Batch ID

credential_id
required
string

Filter by specific credential_id

Responses

Request samples

Content type
application/json
{
  • "api_key": "string",
  • "batch_id": "string",
  • "credential_id": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "payload": {
    },
  • "statistics": {
    }
}