API docs by Redocly

Wealth Reader (8.1.9)

Download OpenAPI specification:

E-mail: info@wealthreader.com

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

Identifiserer klienten i tjenesten

code
string

Navn på enheten. Den komplette listen er tilgjengelig med GET

Eksempel: caixabank

token
string

Identifiserer de forvaltede legitimasjonene. Flyten som tokenet ble oppnådd gjennom er beskrevet i dokumentet 'Widget integrasjonsguide'. Følgende Mock-brukere er tilgjengelige: MOCKDATA, OK-respons; MOCKOTP, respons med OTP-utfordring; MOCKLOGINKO, respons med innloggingsfeil

Eksempel: MOCKDATA

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

Liste over produkttyper som informasjon skal hentes fra. Aksepterer flere verdier atskilt med komma.

Eksempel: accounts,portfolios

only_balances
boolean
Default: false

Angir om det skal hentes bare saldoene til produktene i stedet for all tilgjengelig informasjon. Standardverdi: false.

Eksempel: false

fetch_transaction_details
boolean
Default: false

Angir om utvidede transaksjonsdetaljer skal hentes når enhetens kobling støtter det. VIKTIG: Å aktivere det innebærer å utføre en eller flere ekstra navigasjoner per transaksjon for å berike den returnerte informasjonen. Dette vil uunngåelig og betydelig øke utførelsestiden. Antallet ekstra navigasjoner øker med transaksjonsvolumet. Det anbefales å aktivere det kun når du er sikker på at det kreves et detaljnivå utover det som returneres som standard. De hentede detaljene settes inn i nøkkelen additional_info på nivået for hver transaksjon. Bruk av denne parameteren krever et dedikert miljø.

Eksempel: false

date_from
string <date>

Dato fra hvilken transaksjoner forespørres, i ÅÅÅÅ-MM-DD format. Må være en dato før i dag.

Eksempel: 2024-01-01

date_to
string <date>

Dette gjelder kun for begrensning etter fremtidige datoer for produktene loan og confirming, i ÅÅÅÅ-MM-DD format. Datoen må være senere enn i dag

Eksempel: 2025-12-31

required_products_schema
string

Nødvendig produktskjema. Angir kontoer eller kort som data ønskes fra, med tilleggskonfigurasjoner.

Eksempel: 

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

Aksepterer transaksjons-uuid-er atskilt med komma. Parameter som bare tas i betraktning hvis product_types er ALL eller inkluderer accounts. Legger til PDF-dokumentet knyttet til hver av de forespurte banktransaksjonene.

Eksempel: 

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Velger hvilken tofaktorleveringskanal som skal brukes når API-et returnerte feilkode 2017 eller 20171 (flere OTP-metoder). Kall på nytt med samme økt-ID som i det svaret og sett otp_method til den eksakte strengen i otp_method-feltet til ett objekt i statistics.otpMethods — ikke matriseindeksen. Utelat ved første legitimasjonsforespørsel; send etter brukerens valg. Eksemplet under er illustrativt; kopier alltid strengen fra statistics.otpMethods.

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

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 å hente tokens knyttet til en spesifikk api_key. Resultatene er paginert: limit angir antall tokens per side (maks 500), og page velger hvilken side som returneres. api_key, method og limit er obligatoriske; hvis en av dem mangler eller er ugyldig, svarer API-et med HTTP 400 og feilkode 2.

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

api_key for å identifisere klienten i tjenesten

method
required
string
Value: "get"

Operasjonen som skal utføres. Den eneste støttede verdien er get.

Eksempel: get

limit
required
integer [ 1 .. 500 ]

Antall tokens per side. Minimum 1, maksimum 500.

Eksempel: 100

page
integer >= 1
Default: 1

Angi sidenummeret du vil hente. Hver side inneholder opptil limit tokens. Hvis ikke angitt, er standardverdien 1.

Eksempel: 1

code
string

Enhetskode som brukes til å filtrere tokens. Hvis den utelates, returneres tokens for alle enheter.

Eksempel: bbva

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

Felt som resultatene sorteres etter: created_at (opprettelsesdato) eller accesed_at (siste tilgangsdato). Standard created_at.

Eksempel: created_at

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

Sorteringsrekkefølge: ASC (stigende) eller DESC (synkende). Standard DESC.

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

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

Identifiserer klienten i tjenesten

token
string

Token som skal tilbakekalles.

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 som tokenet skal omtilordnes fra.

api_key_target
string

api_key som tokenet skal omtilordnes til.

token
string

Token som skal omtilordnes.

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

Legg til et nytt domene

Legger til tilknytningen mellom domenet som vil være vert for widgeten og mål-webhooken. For å redigere eller teste domenene dine, bruk https://www.wealthreader.com/clients/

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

Method to execute.

Eksempel: add

api_key
required
string

User's API key.

domain
required
string

Domain to add.

Eksempel: http://desarrollo.cliente.es

url_callback
required
string

URL for callback.

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

tokenize
required
string
Enum: "1" "0"

Kontrollerer om widgeten starter en tokeniseringsprosess:

  • 1 - Brukeren autentiserer seg hos finansinstitusjonen (innlogging, samtykke, 2FA om nødvendig) og et gjenbrukbart token returneres
  • 0 - Ingen tokenisering utføres. Den tidligere innhentede tokenverdien må inkluderes i forespørselen

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

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. Krever en api_key med produktet IBAN_OWNERSHIP autorisert. Den første forespørselen sendes med api_key, iban, document_type, document_number og holder_name. Hvis resultatet returnerer status PENDING, kan verifiseringen forespørres på nytt ved å sende bare api_key og session. NO_RESPONSE er et endelig feilresultat: for å prøve på nytt må en ny verifisering startes uten session.

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)

Eksempel: ES4914651234561234567890

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

Type of identification document

Eksempel: NIF

document_number
required
string

Identification document number

Eksempel: 12345678Z

holder_name
required
string

Full name of the natural person or company name

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

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.

Eksempel: 12345678A

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

Service associated with the user. Determines the data flow.

Eksempel: easy-transfer

email
required
string <email>

User email, used according to service type.

Eksempel: sai_banker@singularbank.com

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.

Eksempel: 12345678A

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.

Eksempel: 12345678A

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

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

Eksempel: easy-transfer

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. Viktig: For å bruke batchprosesshåndtering på Wealthreader-siden, kreves et dedikert miljø. Dette endepunktet er ikke tilgjengelig på api.wealthreader.com. 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>

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.

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

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

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.

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

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

Eksempel: a1b2c3d4

enrollment_id
required
string
Example: enrollment_id=0f3a9c7b1d2e4f5a6b7c8d9e0f1a2b3c

Identifier returned by POST /cards/enrollments/.

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

Eksempel: a1b2c3d4

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

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

Eksempel: 2026-07-01

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

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

Eksempel: 2026-07-11

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

Filters by the email of the employee.

Eksempel: empleado@cliente.com

since_id
integer
Example: since_id=216

Exclusive cursor on the transaction id, for pagination.

Eksempel: 216

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

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

Eksempel: 500

Responses

Response samples

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