API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

PSD2-pohjaiset sääntely-API:t tarjoavat pääsyn tiettyihin taloudellisiin tietoihin, kuten pankkitilisaldoihin ja tapahtumiin. On kuitenkin olemassa muita varallisuustietojen lähteitä, jotka eivät ole saatavilla näiden API:iden kautta. Wealth Reader API laajentaa sääntely-API:iden tarjoamia tietoja tarjoamalla reaaliaikaisen pääsyn lisävarallisuuslähteisiin missä tahansa maailmanlaajuisessa yksikössä. On olemassa kaksi muuta liittyvää asiakirjaa, jotka auttavat sinua integroimaan Wealth Reader API:n. Toinen on Javascript-widgetin integraatio-opas: https://docs-en.wealthreader.com/ ja toinen on Postman-kokoelma, joka perustuu tähän dokumentaatioon. Erittäin tärkeää: Tämä API-määrittely on mukautettu asiakkaille, jotka integroivat Widgetin kautta, joten jotkin parametrit, joita ei tarvita tällaisessa integraatiossa, on jätetty pois, kuten pankkitunnistautumisen parametrit, koska tokenia käytetään.

Core

Ydin-API vaaditaan vakiointegraatioihin

Hakee taloudelliset varat ja niiden koostumustiedot

Hakee taloudelliset varat ja niiden koostumustiedot mukaan lukien sijoitussalkut koostuen osakkeista tai rahastoista, luottokortit, vakuutukset ja lainat. Sisältää omistustiedot jokaiselle varalle sekä yksilölliset tunnisteet, jotka helpottavat tietojen käsittelyä. On mahdollista saada Mock-tietoja. Tarkista tekniseltä tiimiltä miten tämä tehdään.

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

Tapahtumatyyppien luettelo

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Kysy api_key-tunnisteeseen liittyviä tokeneita

Käytä tätä menetelmää kaikkien tiettyyn api_key-tunnisteeseen liittyvien tokenien kyselyyn. Tulokset palautetaan 500 tokenin lohkoissa sivua kohden.

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

Peruuta token

Tämä menetelmä mahdollistaa olemassa olevan tokenin peruuttamisen tulevien API-käyttöpyyntöjen estämiseksi.

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

Määritä token uudelleen eri api_key-tunnisteelle

Tämä menetelmä mahdollistaa tokenin uudelleenmäärityksen yhdestä api_key-tunnisteesta toiseen.

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

Lisää uusi verkkotunnus

Lisää yhteyden widgetin isännöivän verkkotunnuksen ja kohde-webhookin välille. Turvallisuussyistä muokkaus- ja poistotoiminnot ovat mahdollisia vain pyytämällä niitä tuelta

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

Virhekoodiluettelo

Virhekoodiluettelo. Kiinnitä erityistä huomiota siihen, että kaikkia virhekoodeja ei pitäisi käsitellä samalla tavalla sovelluksessasi. Väärän salasanan virheen kohdalla sinun ei pitäisi yrittää kutsua uudelleen samoilla parametreilla, mutta virheen kohdalla, joka osoittaa että entiteetti on huollossa, voit yrittää uudelleen. Pyydä teknistä istuntoa tiimimme kanssa ratkaistaksesi kaikki kysymykset virheenhallinnasta.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Varoituskoodiluettelo

Varoituskoodiluettelo.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Valinnaiset päätepisteet, joita ei vaadita vakiointegraatioihin. Käytä vain, jos Wealth Reader nimenomaisesti ohjeistaa.

Hakee tuettujen yksiköiden luettelon

Hakee tuettujen yksiköiden luettelon ja tiedot, jotka tarvitaan yksikön kirjautumislomakkeen piirtämiseen.

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

Vahvista pankkitilin omistajuus IBAN:in kautta

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Mahdollistaa sen tarkistamisen, onko luonnollinen tai oikeushenkilö tietyn pankkitilin haltija käyttäen IBAN:ia ja väitetyn haltijan tunnistetietoja.

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

Rekisteröi uusi käyttäjä

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tämä päätepiste mahdollistaa käyttäjän rekisteröinnin joko portfolion siirtoalustalle Easytransfer tai raportointityökalulle Acumulas, perustuen yksilölliseen tunnisteeseen.

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

Tarkista käyttäjän rekisteröintitila

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tarkistaa, onko käyttäjä rekisteröity Easytransfer- tai Acumulas-järjestelmään ja palauttaa käyttäjän yksilöllisen pääsylinkin.

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

Peruuta aiemmin rekisteröity käyttäjä

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. Tämä päätepiste mahdollistaa käyttäjän poistamisen Easytransfer- tai Acumulas-alustapalvelusta.

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-yhteyksien lataus

Tämä päätepiste on valinnainen eikä vaadita vakiointegraatioihin. Käytä vain jos Wealth Reader nimenomaisesti ohjeistaa. "batch"-tagin alla ryhmitellyt päätepisteet mahdollistavat useiden pankkiyhteyksien asynkronisen käsittelyn, toisin kuin synkroninen /entities/-menetelmä. Ihanteellinen suurten yhteysvolyymien käsittelyyn ja aikakatkaisujen välttämiseen.

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

Hae yleisiä tilastoja batch-yhteyksistä

Tämä päätepiste on valinnainen. Hakee yleisiä tilastoja kaikkien batch-yhteyksien käsittelytuloksesta.

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

Hae tietyn yhteyden yksittäinen tulos batchin sisällä

Tämä päätepiste on valinnainen. Hakee tietyn yhteyden tuloksen batchista.

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