API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

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

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 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 forespørge alle tokens knyttet til en specifik api_key. Resultaterne returneres i blokke af 500 tokens pr. 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
[
  • {
    }
]

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

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

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

Tilføj et nyt domæne

Tilføjer forbindelsen mellem domænet, der skal hoste widgetten, og destinations-webhook. Af sikkerhedsmæssige årsager er redigerings- og sletteoperationer kun mulige ved at anmode 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 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.

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

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

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.

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.

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

Dette endpoint er valgfrit og ikke påkrævet for standardintegrationer. Brug kun hvis eksplicit instrueret af Wealth Reader. 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>

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