API docs by Redocly

Wealth Reader (8.1.3)

Download OpenAPI specification:

E-mail: [email protected]

API-urile reglementate bazate pe PSD2 oferă acces la anumite informații financiare precum soldurile conturilor bancare și tranzacțiile. Cu toate acestea, există alte surse de informații privind averea care nu sunt accesibile prin aceste API-uri. API-ul Wealth Reader extinde informațiile oferite de API-urile reglementate prin furnizarea accesului în timp real la surse suplimentare de avere în orice entitate din lume. Există alte două documente conexe care vă vor ajuta să integrați API-ul Wealth Reader. Unul este ghidul de integrare a widget-ului Javascript: https://docs-en.wealthreader.com/ iar celălalt este o colecție Postman bazată pe această documentație. Foarte important: Această definiție API este adaptată pentru clienții care integrează prin Widget, astfel încât unii parametri care nu sunt necesari pentru acest tip de integrare au fost omiși, cum ar fi parametrii de autentificare bancară, deoarece va fi utilizat un token.

Core

API principală necesară pentru integrările standard

Preia activele financiare și detaliile compoziției acestora

Preia activele financiare și detaliile compoziției acestora inclusiv portofoliile de investiții compuse din acțiuni sau fonduri, carduri de credit, asigurări și împrumuturi. Include informații de proprietate pentru fiecare activ precum și identificatori unici care facilitează procesarea datelor. Este posibil să se obțină date Mock. Verificați cu echipa tehnică cum să procedați.

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

Identifică clientul în serviciu

code
string

Numele entității. Lista completă este disponibilă cu GET

token
string

Identifică acreditările custodiate. Fluxul prin care a fost obținut token-ul este descris în documentul 'Ghid de integrare Widget'. Următorii utilizatori Mock sunt disponibili: MOCKDATA, răspuns OK; MOCKOTP, răspuns cu provocare OTP; MOCKLOGINKO, răspuns cu eroare de login

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

Lista tipurilor de produse din care se vor prelua informații. Acceptă valori multiple separate prin virgule.

only_balances
boolean
Default: false

Indică dacă se obțin doar soldurile produselor în loc de toate informațiile disponibile. Valoare implicită: false.

date_from
string <date>

Data de la care sunt solicitate tranzacțiile, în format AAAA-LL-ZZ. Trebuie să fie o dată anterioară zilei de azi.

date_to
string <date>

Aceasta se aplică doar pentru restricționarea după date viitoare pentru produsele loan și confirming, în format AAAA-LL-ZZ. Data trebuie să fie ulterioară zilei de azi

required_products_schema
string

Schema produselor necesare. Indică conturile sau cardurile de la care se doresc date, cu configurații suplimentare.

add_pdf_from_uuids
string

Acceptă uuid-uri de tranzacții separate prin virgule. Parametru luat în considerare doar dacă product_types este ALL sau include accounts. Adaugă documentul PDF asociat fiecărei tranzacții bancare solicitate.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&code=caixabank&token=MOCKDATA&product_types=accounts%2Cportfolios&date_from=2024-01-01

Response samples

Content type
application/json
[
  • {
    }
]

Lista tipurilor de tranzacții

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Interogare tokens asociate cu un api_key

Utilizați această metodă pentru a interoga toate token-urile legate de un api_key specific. Rezultatele sunt returnate în blocuri de 500 de token-uri pe pagină.

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

api_key pentru identificarea clientului în serviciu

page
number

Specificați numărul paginii pe care doriți să o recuperați. Fiecare pagină conține până la 500 de token-uri. Dacă nu este furnizat, valoarea implicită este 1.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&page=1

Response samples

Content type
application/json
[
  • {
    }
]

Revocarea unui token

Această metodă permite revocarea unui token existent pentru a dezautoriza viitoarele cereri de acces la API.

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

Identifică clientul în serviciu

token
string

Token de revocat.

Responses

Response samples

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

Reasignarea unui token la un api_key diferit

Această metodă permite reasignarea unui token de la un api_key la altul.

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

api_key de la care se reasignează token-ul.

api_key_target
string

api_key la care se reasignează token-ul.

token
string

Token de reasignat.

Responses

Request samples

Content type
application/x-www-form-urlencoded
api_key_source=12345678&api_key_target=87654321&token=FRJ0mHlaqZwLzu

Response samples

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

Adăugare domeniu nou

Adaugă asocierea între domeniul care va găzdui widget-ul și webhook-ul de destinație. Din motive de securitate, operațiunile de editare și ștergere sunt posibile numai prin solicitarea acestora de la suport

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

Request samples

Content type
application/x-www-form-urlencoded
method=add&api_key=12345678&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"
}

Lista codurilor de eroare

Lista codurilor de eroare. Acordați o atenție deosebită faptului că nu toate codurile de eroare ar trebui să primească același tratament din partea aplicației dvs. Pentru o eroare de parolă incorectă, nu ar trebui să reîncercați apelul cu aceiași parametri, dar pentru o eroare care indică faptul că entitatea este în întreținere, puteți reîncerca. Solicitați o sesiune tehnică cu echipa noastră pentru a rezolva orice întrebări despre gestionarea erorilor.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Lista codurilor de avertizare

Lista codurilor de avertizare.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Puncte finale opționale care nu sunt necesare pentru integrările standard. Utilizați doar dacă Wealth Reader indică în mod explicit.

Preia lista entităților acceptate

Preia lista entităților acceptate și informațiile necesare pentru a desena formularul de conectare al entității.

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

Verificarea titularității contului bancar prin IBAN

Acest endpoint este opțional și nu este necesar pentru integrările standard. Utilizați doar dacă Wealth Reader indică în mod explicit. Permite verificarea dacă o persoană fizică sau juridică este titularul unui cont bancar specific folosind IBAN-ul și datele de identificare ale presupusului titular.

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

Request samples

Content type
application/x-www-form-urlencoded
api_key=12345678&iban=ES4914651234561234567890&document_type=NIF&document_number=12345678Z&holder_name=LUIS%20GARCIA%20BAQUERO

Response samples

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

Înregistrare utilizator nou

Acest endpoint este opțional și nu este necesar pentru integrările standard. Utilizați doar dacă Wealth Reader indică în mod explicit. Acest endpoint permite înregistrarea unui utilizator fie pe platforma de transfer de portofoliu Easytransfer, fie pe instrumentul de raportare Acumulas, pe baza unui identificator unic.

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

Verificare stare înregistrare utilizator

Acest endpoint este opțional și nu este necesar pentru integrările standard. Utilizați doar dacă Wealth Reader indică în mod explicit. Verifică dacă un utilizator este înregistrat în sistemul Easytransfer sau Acumulas și returnează linkul de acces unic pentru utilizator.

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

Revocarea unui utilizator înregistrat anterior

Acest endpoint este opțional și nu este necesar pentru integrările standard. Utilizați doar dacă Wealth Reader indică în mod explicit. Acest endpoint permite anularea înregistrării unui utilizator din serviciul platformei Easytransfer sau Acumulas.

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

Încărcare conexiuni în lot

Acest endpoint este opțional și nu este necesar pentru integrările standard. Utilizați doar dacă Wealth Reader indică în mod explicit. Important: Pentru a utiliza gestionarea proceselor batch din partea Wealthreader, este necesar un mediu dedicat. Acest endpoint nu este disponibil pe api.wealthreader.com. Endpoint-urile grupate sub eticheta "batch" permit procesarea mai multor conexiuni bancare în mod asincron, spre deosebire de metoda /entities/ care este sincronă. Ideal pentru procesarea volumelor mari de conexiuni și evitarea timeout-urilor.

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

Obține statistici generale despre conexiunile batch

Acest endpoint este opțional. Recuperează statistici generale despre rezultatul procesării tuturor conexiunilor dintr-un 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": {
    }
}

Obține rezultatul individual al unei conexiuni specifice dintr-un batch

Acest endpoint este opțional. Recuperează rezultatul unei conexiuni specifice din batch.

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