API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

Op PSD2 gebaseerde regulatorische APIs bieden toegang tot bepaalde financiële informatie zoals banksaldos en transacties. Er zijn echter andere bronnen van vermogensinformatie die niet toegankelijk zijn via deze APIs. De Wealth Reader API breidt de door regulatorische APIs aangeboden informatie uit door realtime toegang te bieden tot extra vermogensbronnen in elke entiteit wereldwijd. Er zijn twee andere gerelateerde documenten die u zullen helpen bij het integreren van de Wealth Reader API. Eén is de Javascript widget integratiegids: https://docs-en.wealthreader.com/ en de ander is een Postman collectie gebaseerd op deze documentatie. Zeer belangrijk: Deze API-definitie is aangepast voor klanten die via Widget integreren, dus sommige parameters die niet nodig zijn voor dit type integratie zijn weggelaten, zoals bankauthenticatieparameters, aangezien een token zal worden gebruikt.

Core

Kern-API vereist voor standaard integraties

Haalt financiële activa en details van hun samenstelling op

Haalt financiële activa en details van hun samenstelling op, inclusief beleggingsportefeuilles samengesteld uit aandelen of fondsen, creditcards, verzekeringen en leningen. Bevat eigendomsinformatie voor elk actief en unieke identificatoren die gegevensverwerking vergemakkelijken. Het is mogelijk om Mock-gegevens te verkrijgen. Controleer bij het technische team hoe dit te doen.

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
[
  • {
    }
]

Lijst van transactietypes

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Tokens opvragen die gekoppeld zijn aan een api_key

Gebruik deze methode om alle tokens op te vragen die gekoppeld zijn aan een specifieke api_key. Resultaten worden geretourneerd in blokken van 500 tokens 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
[
  • {
    }
]

Een token intrekken

Met deze methode kunt u een bestaand token intrekken om toekomstige API-toegangsverzoeken te deautoriseren.

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."
}

Een token toewijzen aan een andere api_key

Met deze methode kunt u een token van de ene api_key naar een andere toewijzen.

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."
}

Een nieuw domein toevoegen

Voegt de associatie toe tussen het domein dat de widget zal hosten en de bestemmings-webhook. Om veiligheidsredenen zijn bewerkings- en verwijderbewerkingen alleen mogelijk door ze aan te vragen bij de ondersteuning

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"
}

Lijst van foutcodes

Lijst van foutcodes. Let er speciaal op dat niet alle foutcodes dezelfde behandeling van uw applicatie moeten krijgen. Bij een onjuist wachtwoordfout moet u de oproep niet opnieuw proberen met dezelfde parameters, maar bij een fout die aangeeft dat de entiteit in onderhoud is, kunt u het opnieuw proberen. Vraag een technische sessie aan met ons team om vragen over foutbeheer op te lossen.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Lijst van waarschuwingscodes

Lijst van waarschuwingscodes.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Optionele eindpunten niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader.

Haalt de lijst van ondersteunde entiteiten op

Haalt de lijst van ondersteunde entiteiten op en de informatie die nodig is om het inlogformulier van de entiteit te tekenen.

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
[
  • {
    }
]

Bankrekeningeigendom verifiëren via IBAN

Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. Maakt het mogelijk te verifiëren of een natuurlijke of rechtspersoon houder is van een specifieke bankrekening met behulp van de IBAN en de identificatiegegevens van de vermeende houder.

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": {
    }
}

Nieuwe gebruiker registreren

Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. Dit endpoint maakt het mogelijk een gebruiker te registreren op het portfolio-overdrachtsplatform Easytransfer of op de rapportagetool Acumulas, gebaseerd op een unieke identificatie.

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"
}

Gebruikersregistratiestatus controleren

Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. Controleert of een gebruiker is geregistreerd in het Easytransfer- of Acumulas-systeem en retourneert de unieke toegangslink voor de gebruiker.

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
{}

Een eerder geregistreerde gebruiker intrekken

Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. Dit endpoint maakt het mogelijk een gebruiker uit te schrijven van de Easytransfer- of Acumulas-platformservice.

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"
}

Batch-verbindingen laden

Dit endpoint is optioneel en niet vereist voor standaard integraties. Gebruik alleen als expliciet geïnstrueerd door Wealth Reader. De endpoints gegroepeerd onder de "batch" tag maken het mogelijk meerdere bankverbindingen asynchroon te verwerken, in tegenstelling tot de synchrone /entities/ methode. Ideaal voor grote volumes verbindingen en het vermijden van timeouts.

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"
}

Algemene statistieken over batch-verbindingen ophalen

Dit endpoint is optioneel. Haalt algemene statistieken op over het verwerkingsresultaat van alle verbindingen in een 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": {
    }
}

Individueel resultaat van een specifieke verbinding binnen een batch ophalen

Dit endpoint is optioneel. Haalt het resultaat van een specifieke verbinding uit de batch op.

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": {
    }
}