API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

Regulatory APIs based on PSD2 provide access to certain financial information such as bank account balances and transactions. However, there are other sources of wealth information that are not accessible through these APIs. The Wealth Reader API extends the information offered by regulatory APIs by providing real-time access to additional wealth sources in any entity worldwide. There are two other related documents that will help you integrate the Wealth Reader API. One is the Javascript widget integration guide: https://docs-en.wealthreader.com/ and the other is a Postman collection based on this documentation. Very important: This API definition is adapted for clients integrating via Widget, so some parameters that are not necessary for this type of integration have been omitted, such as bank authentication parameters, as a token will be used.

Core

Core API required for standard integrations

Henter finansielle eiendeler og detaljer om deres sammensetning

Henter finansielle eiendeler og detaljer om deres sammensetning inkludert investeringsporteføljer sammensatt av aksjer eller fond, kredittkort, forsikringer og lån. Inkluderer eierskapsinformasjon for hver eiendel samt unike identifikatorer som letter databehandling. Det er mulig å få Mock-data. Sjekk med det tekniske teamet hvordan dette gjøres.

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

Liste over transaksjonstyper

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Spør etter tokens knyttet til en api_key

Bruk denne metoden for å spørre etter alle tokens knyttet til en spesifikk api_key. Resultatene returneres i blokker på 500 tokens per side.

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

Tilbakekall et token

Denne metoden tillater tilbakekalling av et eksisterende token for å deautorisere fremtidige API-tilgangsforespørsler.

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

Tilordne et token til en annen api_key

Denne metoden tillater tilordning av et token fra én api_key til en annen.

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

Legg til et nytt domene

Legger til tilknytningen mellom domenet som vil være vert for widgeten og mål-webhooken. Av sikkerhetsgrunner er redigerings- og slettoperasjoner kun mulig ved å be om dem fra support

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

Liste over feilkoder

Liste over feilkoder. Vær spesielt oppmerksom på at ikke alle feilkoder skal behandles likt av applikasjonen din. For en feil med feil passord, bør du ikke prøve kallet på nytt med de samme parameterne, men for en feil som indikerer at enheten er under vedlikehold, kan du prøve igjen. Be om en teknisk sesjon med teamet vårt for å løse eventuelle spørsmål om feilhåndtering.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Liste over advarselskoder

Liste over advarselskoder.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Optional endpoints not required for standard integrations. Use only if explicitly instructed by Wealth Reader.

Henter listen over støttede enheter

Henter listen over støttede enheter og informasjonen som trengs for å tegne påloggingskjemaet for enheten.

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

Verifiser bankkontoeierskap via IBAN

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Tillater verifisering av om en fysisk eller juridisk person er innehaver av en spesifikk bankkonto ved bruk av IBAN og identifikasjonsdata til den påståtte innehaveren.

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

Registrer en ny bruker

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Dette endepunktet tillater registrering av en bruker enten på porteføljeoverføringsplattformen Easytransfer eller på rapporteringsverktøyet Acumulas, basert på en unik identifikator.

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

Sjekk brukerregistreringsstatus

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Sjekker om en bruker er registrert i Easytransfer- eller Acumulas-systemet og returnerer den unike tilgangslinken for brukeren.

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

Tilbakekall en tidligere registrert bruker

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Dette endepunktet tillater avregistrering av en bruker fra Easytransfer- eller Acumulas-plattformtjenesten.

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

Dette endepunktet er valgfritt og ikke nødvendig for standardintegrasjoner. Bruk kun hvis eksplisitt instruert av Wealth Reader. Endpoint-ene gruppert under "batch"-taggen tillater asynkron behandling av flere bankforbindelser, i motsetning til den synkrone /entities/-metoden. Ideell for behandling av store volumer av forbindelser og unngå 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"
}

Hent generelle statistikker om batch-tilkoblinger

Dette endepunktet er valgfritt. Henter generelle statistikker om behandlingsresultatet for alle tilkoblinger i en 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": {
    }
}

Hent individuelt resultat av en spesifikk tilkobling innenfor en batch

Dette endepunktet er valgfritt. Henter resultatet av en spesifikk tilkobling fra batchen.

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