API docs by Redocly

Wealth Reader (8.1.9)

Download OpenAPI specification:

E-mail: info@wealthreader.com

Regulatoriske API'er baseret på PSD2 giver adgang til visse finansielle oplysninger såsom banksaldi og transaktioner. Der findes dog andre kilder til formueoplysninger, der ikke er tilgængelige gennem disse API'er. Wealth Reader API udvider de oplysninger, der tilbydes af regulatoriske API'er, ved at give realtidstilgang til yderligere formuekilder i enhver enhed verden over. Der findes to andre relaterede dokumenter, der vil hjælpe dig med at integrere Wealth Reader API. Den ene er Javascript widget integrationsguiden: https://docs-en.wealthreader.com/ og den anden er en Postman samling baseret på denne dokumentation. Meget vigtigt: Denne API-definition er tilpasset kunder, der integrerer via Widget, så nogle parametre, der ikke er nødvendige for denne type integration, er udeladt, såsom bankgodkendelsesparametre, da et token vil blive brugt.

Core

Kærne-API påkrævet til standardintegrationer

Henter finansielle aktiver og detaljer om deres sammensætning

Henter finansielle aktiver og detaljer om deres sammensætning inklusive investeringsporteføljer sammensat af aktier eller fonde, kreditkort, forsikringer og lån. Inkluderer ejerskabsoplysninger for hver aktiv samt unikke identifikatorer, der letter databehandling. Det er muligt at få Mock-data. Tjek med det tekniske team hvordan dette gøres.

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

Identificerer klienten i tjenesten

code
string

Navn på enheden. Den komplette liste er tilgængelig med GET

Eksempel: caixabank

token
string

Identificerer de opbevarede legitimationsoplysninger. Flowet, hvormed tokenet blev opnået, er beskrevet i dokumentet 'Widget integrationsvejledning'. Følgende Mock-brugere er tilgængelige: MOCKDATA, OK-svar; MOCKOTP, svar med OTP-udfordring; MOCKLOGINKO, svar med login-fejl

Eksempel: MOCKDATA

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

Liste over produkttyper, hvorfra information skal hentes. Accepterer flere værdier adskilt med kommaer.

Eksempel: accounts,portfolios

only_balances
boolean
Default: false

Angiver, om der kun skal hentes saldi for produkterne i stedet for al tilgængelig information. Standardværdi: false.

Eksempel: false

fetch_transaction_details
boolean
Default: false

Angiver, om der skal hentes udvidede transaktionsdetaljer, når enhedens connector understøtter det. VIGTIGT: Aktivering indebærer udførelse af en eller flere yderligere navigationer pr. transaktion for at berige de returnerede oplysninger. Dette vil uundgåeligt og betydeligt øge udførelsestiden. Antallet af yderligere navigationer vokser med transaktionsvolumenet. Det anbefales kun at aktivere det, når du er sikker på, at der kræves et detaljeniveau ud over det, der returneres som standard. De hentede detaljer indsættes i nøglen additional_info på niveau for hver transaktion. Brugen af denne parameter kræver et dedikeret miljø.

Eksempel: false

date_from
string <date>

Dato fra hvilken transaktioner anmodes om, i ÅÅÅÅ-MM-DD format. Skal være en dato før i dag.

Eksempel: 2024-01-01

date_to
string <date>

Dette gælder kun for begrænsning efter fremtidige datoer for produkterne loan og confirming, i ÅÅÅÅ-MM-DD format. Datoen skal være senere end i dag

Eksempel: 2025-12-31

required_products_schema
string

Påkrævet produktskema. Angiver de konti eller kort, hvorfra data ønskes, med yderligere konfigurationer.

Eksempel: 

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

Accepterer transaktions-uuid'er adskilt med kommaer. Parameter, der kun tages i betragtning, hvis product_types er ALL eller inkluderer accounts. Tilføjer PDF-dokumentet tilknyttet hver af de anmodede banktransaktioner.

Eksempel: 

20966426721d0885ef9d4b95535e1d3198936f16,8772d6c978d37d7af83094abf380b8b703e94105,e59296b79e7f80cec26679d2c65883025fd59295
otp_method
string

Vælger hvilken tofaktor-leveringskanal der skal bruges, når API'et returnerede fejlkode 2017 eller 20171 (flere OTP-metoder). Kald igen med samme sessions-ID som i det svar og sæt otp_method til den præcise streng i otp_method-feltet for et objekt i statistics.otpMethods — ikke array-indeks. Udelad ved første credential-forespørgsel; send efter brugerens valg. Eksemplet nedenfor er illustrativt; kopier altid 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 transaktionstyper

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Forespørg tokens tilknyttet en api_key

Brug denne metode til at hente tokens knyttet til en specifik api_key. Resultaterne er pagineret: limit angiver antallet af tokens pr. side (højst 500), og page vælger den side, der returneres. api_key, method og limit er obligatoriske; hvis en af dem mangler eller er ugyldig, svarer API'et med HTTP 400 og fejlkode 2.

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

api_key til at identificere klienten i tjenesten

method
required
string
Value: "get"

Handling, der skal udføres. Den eneste understøttede værdi er get.

Eksempel: get

limit
required
integer [ 1 .. 500 ]

Antal tokens pr. side. Minimum 1, maksimum 500.

Eksempel: 100

page
integer >= 1
Default: 1

Angiv sidenummeret du vil hente. Hver side indeholder op til limit tokens. Hvis ikke angivet, er standardværdien 1.

Eksempel: 1

code
string

Enhedskode, der bruges til at filtrere tokens. Hvis den udelades, returneres tokens for alle enheder.

Eksempel: bbva

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

Felt, som resultaterne sorteres efter: created_at (oprettelsesdato) eller accesed_at (sidste adgangsdato). Standard created_at.

Eksempel: created_at

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

Sorteringsretning: ASC (stigende) eller DESC (faldende). 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": {
    }
}

Tilbagekald et token

Denne metode tillader tilbagekaldelse af et eksisterende token for at deautorisere fremtidige API-adgangsanmodninger.

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

Identificerer klienten i tjenesten

token
string

Token der skal tilbagekaldes.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Token successfully revoked."
}

Gentildel et token til en anden api_key

Denne metode tillader gentildeling af et token fra én api_key til en anden.

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

api_key hvorfra tokenet skal gentildeles.

api_key_target
string

api_key som tokenet skal gentildeles til.

token
string

Token der skal gentildeles.

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

Tilføj et nyt domæne

Tilføjer forbindelsen mellem domænet, der skal hoste widgetten, og destinations-webhook. For at redigere eller teste dine domæner, brug 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"

Styrer om widgeten starter et tokeniseringsforløb:

  • 1 - Brugeren autentificerer sig hos den finansielle institution (login, samtykke, 2FA hvis påkrævet) og et genanvendeligt token returneres
  • 0 - Der udføres ingen tokenisering. Den tidligere indhentede tokenværdi skal inkluderes i anmodningen

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 fejlkoder

Liste over fejlkoder. Vær særligt opmærksom på, at ikke alle fejlkoder skal modtage den samme behandling fra din applikation. For en forkert adgangskode-fejl skal du ikke prøve kaldet igen med de samme parametre, men for en fejl, der indikerer, at enheden er under vedligeholdelse, kan du prøve igen. Anmod om en teknisk session med vores team for at løse eventuelle spørgsmål om fejlhå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

Valgfrie endpoints, der ikke kræves til standardintegrationer. Brug kun, hvis eksplicit instrueret af Wealth Reader.

Henter listen over understøttede enheder

Henter listen over understøttede enheder og oplysningerne, der er nødvendige for at tegne enhedens login-formular.

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

Verificer bankkontoejerskab via IBAN

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Tillader verifikation af om en fysisk eller juridisk person er indehaver af en specifik bankkonto ved brug af IBAN og identifikationsdata for den påståede indehaver. Kræver en api_key med produktet IBAN_OWNERSHIP autoriseret. Den indledende anmodning sendes med api_key, iban, document_type, document_number og holder_name. Hvis resultatet returnerer status PENDING, kan verifikationen forespørges igen ved kun at sende api_key og session. NO_RESPONSE er et endeligt fejlresultat: for at prøve igen skal en ny verifikation startes uden 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 bruger

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Dette endpoint tillader registrering af en bruger enten på porteføljeoverførselsplatformen Easytransfer eller på rapporteringsværktøjet Acumulas, baseret 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"
}

Tjek brugerregistreringsstatus

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Tjekker om en bruger er registreret i Easytransfer- eller Acumulas-systemet og returnerer det unikke adgangslink for brugeren.

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

Tilbagekald en tidligere registreret bruger

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Dette endpoint tillader afregistrering af en bruger fra Easytransfer- eller Acumulas-platformtjenesten.

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-forbindelsesindlæsning

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. Vigtigt: For at bruge batchproceshåndtering på Wealthreader-siden kræves et dedikeret miljø. Dette endpoint er ikke tilgængeligt på api.wealthreader.com. Endpoints grupperet under "batch"-tagget tillader asynkron behandling af flere bankforbindelser, i modsætning til den synkrone /entities/ metode. Ideel til behandling af store mængder forbindelser og undgåelse af 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-forbindelser

Dette endpoint er valgfrit. Henter generelle statistikker om behandlingsresultatet for alle forbindelser 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 af en specifik forbindelse inden for en batch

Dette endpoint er valgfrit. Henter resultatet af en specifik forbindelse 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": {
    }
}