API docs by Redocly

Wealth Reader (8.1.3)

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

Identificeert de klant in de dienst

code
string

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

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

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

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

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.

date_from
string <date>

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

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

required_products_schema
string

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

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.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&code=caixabank&token=MOCKDATA&product_types=accounts%2Cportfolios&date_from=2024-01-01

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 om de klant in de dienst te identificeren

page
number

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

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&page=1

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

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.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key_source=12345678&api_key_target=87654321&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 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

Request samples

Content type
application/x-www-form-urlencoded
method=add&api_key=12345678&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.

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

Request samples

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

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

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