API docs by Redocly

Wealth Reader (8.1.9)

Download OpenAPI specification:

E-mail: info@wealthreader.com

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

Identificeert de klant in de dienst

code
string

Naam van de entiteit. De volledige lijst is beschikbaar met GET

Voorbeeld: caixabank

token
string

Identificeert de bewaarde inloggegevens. De flow waarmee het token is verkregen staat beschreven in het document 'Widget Integratiegids'. De volgende Mock-gebruikers zijn beschikbaar: MOCKDATA, OK-antwoord; MOCKOTP, antwoord met OTP-uitdaging; MOCKLOGINKO, antwoord met login-fout

Voorbeeld: MOCKDATA

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

Lijst van producttypen waarvan informatie moet worden opgehaald. Accepteert meerdere waarden gescheiden door komma's.

Voorbeeld: accounts,portfolios

only_balances
boolean
Default: false

Geeft aan of alleen de saldi van de producten moeten worden opgehaald in plaats van alle beschikbare informatie. Standaardwaarde: false.

Voorbeeld: false

fetch_transaction_details
boolean
Default: false

Geeft aan of uitgebreide transactiegegevens moeten worden opgehaald wanneer de connector van de entiteit dit ondersteunt. BELANGRIJK: Het inschakelen ervan houdt in dat er een of meer extra navigaties per transactie worden uitgevoerd om de geretourneerde informatie te verrijken. Dit zal de uitvoeringstijd onvermijdelijk en aanzienlijk verhogen. Het aantal extra navigaties groeit met het volume aan transacties. Het wordt aanbevolen dit alleen in te schakelen wanneer u zeker weet dat een hoger detailniveau dan standaard wordt geretourneerd vereist is. De opgehaalde gegevens worden ingevoegd in de sleutel additional_info op het niveau van elke transactie. Het gebruik van deze parameter vereist een toegewijde omgeving.

Voorbeeld: false

date_from
string <date>

Datum vanaf wanneer transacties worden opgevraagd, in JJJJ-MM-DD formaat. Moet een datum voor vandaag zijn.

Voorbeeld: 2024-01-01

date_to
string <date>

Dit geldt alleen voor beperking op toekomstige datums voor producten loan en confirming, in JJJJ-MM-DD formaat. De datum moet later zijn dan vandaag

Voorbeeld: 2025-12-31

required_products_schema
string

Schema van vereiste producten. Geeft de rekeningen of kaarten aan waarvan gegevens gewenst zijn, met aanvullende configuraties.

Voorbeeld: 

{
  "ACCOUNTS": {
    "0ae4d722b1c82feeafb4b36b2893230444071335": {
      "only_balances": false,
      "add_pdf_from_uuids": [
        "90763109952d4f2ebece8dceca8254078c5384a0"
      ],
      "date_from": "2024-04-03"
    }
  },
  "CARDS": {
    "957e6f63546f3fecacce80192b6f7436496dc057": {}
  }
}
add_pdf_from_uuids
string

Accepteert transactie-uuid's gescheiden door komma's. Parameter die alleen in aanmerking wordt genomen als product_types ALL is of accounts bevat. Voegt het PDF-document toe dat bij elk van de gevraagde banktransacties hoort.

Voorbeeld: 

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Selecteert welk tweefactorleveringskanaal te gebruiken wanneer de API foutcode 2017 of 20171 retourneerde (meerdere OTP-methoden). Roep opnieuw aan met dezelfde sessie-ID als die reactie en zet otp_method op de exacte string in het otp_method-veld van een object in statistics.otpMethods — niet de array-index. Weglaten bij eerste credential-verzoek; meesturen na keuze van de gebruiker. Het voorbeeld hieronder is ter illustratie; kopieer altijd de string uit statistics.otpMethods voor uw entiteit.

Voorbeeld: OTP_SMS ****1234

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=a1b2c3d4e5f6g7h8i9j0&code=caixabank&token=1234Asdf&product_types=accounts%2Cportfolios&only_balances=false&date_from=2024-01-01&date_to=2025-12-31&required_products_schema=%7B%22ACCOUNTS%22%3A%7B%220ae4d722b1c82feeafb4b36b2893230444071335%22%3A%7B%22only_balances%22%3Afalse%2C%22add_pdf_from_uuids%22%3A%5B%2290763109952d4f2ebece8dceca8254078c5384a0%22%5D%2C%22date_from%22%3A%222024-04-03%22%7D%7D%2C%22CARDS%22%3A%7B%22957e6f63546f3fecacce80192b6f7436496dc057%22%3A%7B%7D%7D%7D&add_pdf_from_uuids=20966426721d0885ef9d4b95535e1d3198936f16%2C8772d6c978d37d7af83094abf380b8b703e94105

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 de tokens op te vragen die gekoppeld zijn aan een specifieke api_key. De resultaten zijn gepagineerd: limit bepaalt het aantal tokens per pagina (maximaal 500) en page kiest de pagina die wordt geretourneerd. api_key, method en limit zijn verplicht; als een ervan ontbreekt of ongeldig is, antwoordt de API met HTTP 400 en foutcode 2.

Request Body schema: application/x-www-form-urlencoded
required
api_key
required
string^[a-z0-9]{8}$

api_key om de klant in de dienst te identificeren

method
required
string
Value: "get"

Uit te voeren bewerking. De enige ondersteunde waarde is get.

Voorbeeld: get

limit
required
integer [ 1 .. 500 ]

Aantal tokens per pagina. Minimaal 1, maximaal 500.

Voorbeeld: 100

page
integer >= 1
Default: 1

Specificeer het paginanummer dat u wilt ophalen. Elke pagina bevat maximaal limit tokens. Indien niet opgegeven, is de standaardwaarde 1.

Voorbeeld: 1

code
string

Entiteitscode om de tokens op te filteren. Indien weggelaten, worden de tokens van alle entiteiten geretourneerd.

Voorbeeld: bbva

sort_by
string
Default: "created_at"
Enum: "created_at" "accesed_at"

Veld waarop de resultaten worden gesorteerd: created_at (aanmaakdatum) of accesed_at (laatste toegangsdatum). Standaard created_at.

Voorbeeld: created_at

sort_order
string
Default: "DESC"
Enum: "ASC" "DESC"

Sorteervolgorde: ASC (oplopend) of DESC (aflopend). Standaard DESC.

Voorbeeld: DESC

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=a1b2c3d4&method=get&limit=100&page=1

Response samples

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

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

Identificeert de klant in de dienst

token
string

Token dat moet worden ingetrokken.

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 waarvan het token opnieuw moet worden toegewezen.

api_key_target
string

api_key waaraan het token opnieuw moet worden toegewezen.

token
string

Token dat opnieuw moet worden toegewezen.

Voorbeeld: FRJ0mHlaqZwLzu

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key_source=a1b2c3d4e5f6g7h8i9j0&api_key_target=b2c3d4e5f6g7h8i9j0k1&token=FRJ0mHlaqZwLzu

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 uw domeinen te bewerken of te testen, gebruikt u https://www.wealthreader.com/clients/

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

Method to execute.

Voorbeeld: add

api_key
required
string

User's API key.

domain
required
string

Domain to add.

Voorbeeld: http://desarrollo.cliente.es

url_callback
required
string

URL for callback.

Voorbeeld: https://desarrollo.cliente.es/hooks/wealthreader

tokenize
required
string
Enum: "1" "0"

Bepaalt of de widget een tokenisatiestroom start:

  • 1 - De gebruiker authenticeert zich bij de financiële instelling (login, toestemming, 2FA indien vereist) en een herbruikbaar token wordt teruggegeven
  • 0 - Er wordt geen tokenisatie uitgevoerd. De eerder verkregen tokenwaarde moet in het verzoek worden opgenomen

Voorbeeld: 1

Responses

Request samples

Content type
application/x-www-form-urlencoded
method=add&api_key=a1b2c3d4e5f6g7h8i9j0&domain=https%3A%2F%2Fwww.cliente.com&url_callback=https%3A%2F%2Fwww.cliente.com%2Fwebhooks%2Fwealthreader&tokenize=1

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. Vereist een api_key met het product IBAN_OWNERSHIP geautoriseerd. Het eerste verzoek wordt verzonden met api_key, iban, document_type, document_number en holder_name. Als het resultaat de status PENDING retourneert, kan de verificatie opnieuw worden opgevraagd door alleen api_key en session te verzenden. NO_RESPONSE is een definitief foutresultaat: om het opnieuw te proberen moet een nieuwe verificatie zonder session worden gestart.

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

Identifies the client in the service. It must have the IBAN_OWNERSHIP product authorized.

iban
required
string

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

Voorbeeld: ES4914651234561234567890

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

Type of identification document

Voorbeeld: NIF

document_number
required
string

Identification document number

Voorbeeld: 12345678Z

holder_name
required
string

Full name of the natural person or company name

Voorbeeld: LUIS GARCIA BAQUERO

Responses

Request samples

Content type
application/x-www-form-urlencoded
Example
api_key=a1b2c3d4e5f6g7h8i9j0&iban=ES4914651234561234567890&document_type=NIF&document_number=12345678Z&holder_name=LUIS%20GARCIA%20BAQUERO

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "payload": {
    },
  • "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.

Voorbeeld: 12345678A

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

Service associated with the user. Determines the data flow.

Voorbeeld: easy-transfer

email
required
string <email>

User email, used according to service type.

Voorbeeld: sai_banker@singularbank.com

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.

Voorbeeld: 12345678A

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.

Voorbeeld: 12345678A

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

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

Voorbeeld: easy-transfer

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. Belangrijk: Om batchprocesbeheer aan de Wealthreader-kant te gebruiken, is een dedicated omgeving vereist. Dit endpoint is niet beschikbaar op api.wealthreader.com. 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>

Webhook URL. A notification is sent to this URL for each individual credential as soon as it completes processing, not only once all connections in the batch are done.

Voorbeeld: https://example.com/webhook/batch-complete

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

List of connections to process

Responses

Callbacks

Request samples

Content type
application/json
{
  • "api_key": "a1b2c3d4e5f6g7h8i9j0",
  • "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"
}

Callback payload samples

Callback
POST: Webhook fired when a credential finishes processing
Content type
application/json
{
  • "batch_id": 10863151,
  • "credential_id": "cred_demo_002",
  • "status": "completed",
  • "timestamp": "2026-05-13T08:02:47+00:00"
}

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

Cards (real time)

Real-time card expense synchronization from the Open Sync mobile app: per-customer employee pre-registration, signed webhooks (card_transaction.created / card_enrollment.confirmed), and REST query / backfill.

Register or rotate the real-time cards webhook

Creates or updates the webhook URL of the customer for the card_transaction.created and card_enrollment.confirmed events (see the cards-webhook-delivery schema for the delivery format and signature). On first setup, or when rotate_secret is true, a new webhook_secret (64 hex characters) is generated and returned once; in any other case webhook_secret comes back as null in the response and cannot be retrieved again. webhook_url must always be https:// and must resolve to a publicly routable host: localhost, private, loopback, link-local (including the cloud metadata address), CGNAT, multicast and reserved addresses are rejected, in any notation (hexadecimal, decimal, octal, short dotted or IPv4-mapped IPv6), and so is a hostname that does not resolve at all. The same check runs again right before every delivery, not only at registration: if the host is repointed at an internal address afterwards (DNS rebinding) the delivery is closed as failed with response_excerpt "blocked_host". Sending null in webhook_url disables webhooks for that customer; omitting the field leaves the stored URL untouched, which is how the secret is rotated without changing the URL.

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

webhook_url
string or null

https:// URL that will receive the events, on a publicly routable host that resolves in DNS. null disables webhooks; omitting the field leaves the stored URL unchanged.

Voorbeeld: https://cliente.example.com/webhooks/wealthreader-cards

rotate_secret
boolean
Default: false

When true, generates and returns a new webhook_secret.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Pre-register the email of an employee

Creates an enrollment request in pending status with a short expiry (ttl_minutes, 20 by default, between 1 and 60) for the employee to confirm by opening the mobile app and entering that email (POST /user-sync-validation/, no contract change for the app). It is idempotent: repeating the call for the same (api_key, email) while it is still pending and not expired returns the same request. If the email is already linked to the calling customer, it returns status "active" directly. If it is already linked to a different customer, it returns 409. Rate limit: at most 60 calls to this endpoint per api_key every 60 seconds, counting every attempt and not only the ones that create a row, checked before anything else so the answers that create nothing (200 already active, 409 linked to another customer, 400) cannot be walked as an enumeration oracle. Exceeding it returns 429 with code rate_limited.

Request Body schema: application/json
required
api_key
required
string

API key of the customer.

email
required
string <email>

Email of the employee to pre-register.

Voorbeeld: empleado@cliente.com

ttl_minutes
integer [ 1 .. 60 ]
Default: 20

Minutes the request stays valid before expiring.

Responses

Request samples

Content type
application/json
{
  • "api_key": "a1b2c3d4",
  • "email": "empleado@cliente.com",
  • "ttl_minutes": 20
}

Response samples

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

Check the status of an enrollment

Read-only status of an enrollment request. It has no side effects on card users, unlike POST /user-sync-validation/, which does confirm. The only write allowed is lazily marking a pending enrollment whose expiry date has already passed as expired.

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

API key of the customer. Note it travels in the query string, so it ends up in access logs and intermediary proxies.

Voorbeeld: a1b2c3d4

enrollment_id
required
string
Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Identifier returned by POST /cards/enrollments/.

Voorbeeld: 0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Responses

Response samples

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

Query / backfill real-time card transactions

Returns the real-time card transactions received for the employees linked to this api_key, ordered by ascending id. Meant both for periodic backfill (poll with date_from/date_to and paginate with since_id) and for one-off queries. This is the same transaction object carried by the card_transaction.created webhook.

query Parameters
api_key
required
string
Example: api_key=a1b2c3d4

API key of the customer. Note it travels in the query string, so it ends up in access logs and intermediary proxies.

Voorbeeld: a1b2c3d4

date_from
string <date>
Example: date_from=2026-07-01

YYYY-MM-DD, on the operation date. Default: today minus 3 days.

Voorbeeld: 2026-07-01

date_to
string <date>
Example: date_to=2026-07-11

YYYY-MM-DD, on the operation date. Default: today.

Voorbeeld: 2026-07-11

email
string <email>
Example: email=empleado@cliente.com

Filters by the email of the employee.

Voorbeeld: empleado@cliente.com

since_id
integer
Example: since_id=216

Exclusive cursor on the transaction id, for pagination.

Voorbeeld: 216

limit
integer <= 1000
Default: 500
Example: limit=500

Maximum number of transactions to return (500 by default, 1000 max).

Voorbeeld: 500

Responses

Response samples

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