API docs by Redocly

Wealth Reader (8.1.3)

Download OpenAPI specification:

E-mail: [email protected]

Auf PSD2 basierende regulatorische APIs bieten Zugang zu bestimmten finanziellen Informationen wie Bankkontensalden und Transaktionen. Es gibt jedoch andere Quellen von Vermögensinformationen, die über diese APIs nicht zugänglich sind. Die Wealth Reader API erweitert die von regulatorischen APIs angebotenen Informationen, indem sie Echtzeitzugang zu zusätzlichen Vermögensquellen in jeder Einrichtung weltweit bietet. Es gibt zwei weitere verwandte Dokumente, die Ihnen bei der Integration der Wealth Reader API helfen werden. Eines ist der Javascript-Widget-Integrationsleitfaden: https://docs-en.wealthreader.com/ und das andere ist eine auf dieser Dokumentation basierende Postman-Sammlung. Sehr wichtig: Diese API-Definition ist für Kunden angepasst, die über Widget integrieren, daher wurden einige Parameter weggelassen, die für diesen Integrationstyp nicht notwendig sind, wie z.B. Bankauthentifizierungsparameter, da ein Token verwendet wird.

Core

Kern-API erforderlich für Standardintegrationen

Ruft Finanzanlagen und deren Zusammensetzungsdetails ab

Ruft Finanzanlagen und Details ihrer Zusammensetzung ab, einschließlich Investmentportfolios bestehend aus Aktien oder Fonds, Kreditkarten, Versicherungen und Darlehen. Enthält Eigentumsinformationen für jedes Asset sowie eindeutige Kennungen, die die Datenverarbeitung erleichtern. Es ist möglich, Mock-Daten zu erhalten. Erkundigen Sie sich beim technischen Team, wie das geht.

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

Identifiziert den Kunden im Dienst

code
string

Name der Einrichtung. Die vollständige Liste ist mit GET verfügbar

token
string

Identifiziert die verwalteten Anmeldedaten. Der Ablauf, durch den das Token erhalten wurde, ist im Dokument 'Widget-Integrationsleitfaden' beschrieben. Die folgenden Mock-Benutzer sind verfügbar: MOCKDATA, OK-Antwort; MOCKOTP, Antwort mit OTP-Herausforderung; MOCKLOGINKO, Antwort mit Login-Fehler

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

Liste der Produkttypen, deren Informationen abgerufen werden sollen. Akzeptiert mehrere durch Kommas getrennte Werte.

only_balances
boolean
Default: false

Gibt an, ob nur die Salden der Produkte anstelle aller verfügbaren Informationen abgerufen werden sollen. Standardwert: false.

date_from
string <date>

Datum, ab dem Transaktionen angefordert werden, im Format JJJJ-MM-TT. Muss ein Datum vor heute sein.

date_to
string <date>

Dies gilt nur für die Einschränkung nach zukünftigen Daten für Produkte Loan und Confirming, im Format JJJJ-MM-TT. Das Datum muss nach heute liegen

required_products_schema
string

Schema der erforderlichen Produkte. Gibt die Konten oder Karten an, von denen Daten gewünscht werden, mit zusätzlichen Konfigurationen.

add_pdf_from_uuids
string

Akzeptiert durch Kommas getrennte Transaktions-UUIDs. Parameter wird nur berücksichtigt, wenn product_types ALL ist oder accounts enthält. Fügt das mit jeder angeforderten Banktransaktion verknüpfte PDF-Dokument hinzu.

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

Liste der Transaktionstypen

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Tokens abfragen, die mit einem api_key verknüpft sind

Verwenden Sie diese Methode, um alle mit einem bestimmten api_key verknüpften Tokens abzufragen. Die Ergebnisse werden in Blöcken von 500 Tokens pro Seite zurückgegeben.

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

api_key zur Identifizierung des Kunden im Dienst

page
number

Geben Sie die Seitennummer an, die Sie abrufen möchten. Jede Seite enthält bis zu 500 Tokens. Wenn nicht angegeben, ist der Standardwert 1.

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Einen Token widerrufen

Diese Methode ermöglicht das Widerrufen eines vorhandenen Tokens, um zukünftige API-Zugriffsanfragen zu deautorisieren.

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

Identifiziert den Kunden im Dienst

token
string

Token, das widerrufen werden soll.

Responses

Response samples

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

Einen Token einem anderen api_key zuweisen

Diese Methode ermöglicht die Neuzuweisung eines Tokens von einem api_key zu einem anderen.

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

api_key, von dem der Token neu zugewiesen werden soll.

api_key_target
string

api_key, zu dem der Token neu zugewiesen werden soll.

token
string

Token, das neu zugewiesen werden soll.

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

Neue Domain hinzufügen

Fügt die Verknüpfung zwischen der Domain, die das Widget hosten wird, und dem Ziel-Webhook hinzu. Aus Sicherheitsgründen sind Bearbeitungs- und Löschvorgänge nur durch Anfrage beim Support möglich

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

Liste der Fehlercodes

Liste der Fehlercodes. Achten Sie besonders darauf, dass nicht alle Fehlercodes von Ihrer Anwendung gleich behandelt werden sollten. Bei einem falschen Passwortfehler sollten Sie den Aufruf nicht mit denselben Parametern wiederholen, aber bei einem Fehler, der anzeigt, dass die Entität gewartet wird, können Sie es erneut versuchen. Fordern Sie eine technische Sitzung mit unserem Team an, um Fragen zur Fehlerverwaltung zu klären.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Liste der Warnungscodes

Liste der Warnungscodes.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Optionale Endpunkte, die für Standardintegrationen nicht erforderlich sind. Nur verwenden, wenn explizit von Wealth Reader angewiesen.

Ruft die Liste der unterstützten Einrichtungen ab

Ruft die Liste der unterstützten Einrichtungen und die Informationen ab, die zum Zeichnen des Anmeldeformulars der Einrichtung benötigt werden.

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

Bankkontoinhaberschaft über IBAN verifizieren

Dieser Endpoint ist optional und für Standardintegrationen nicht erforderlich. Nur verwenden, wenn explizit von Wealth Reader angewiesen. Ermöglicht die Überprüfung, ob eine natürliche oder juristische Person Inhaber eines bestimmten Bankkontos ist, unter Verwendung der IBAN und der Identifikationsdaten des mutmaßlichen Inhabers.

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

Neuen Benutzer registrieren

Dieser Endpoint ist optional und für Standardintegrationen nicht erforderlich. Nur verwenden, wenn explizit von Wealth Reader angewiesen. Dieser Endpoint ermöglicht die Registrierung eines Benutzers entweder auf der Portfolio-Transfer-Plattform Easytransfer oder auf dem Reporting-Tool Acumulas, basierend auf einem eindeutigen 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"
}

Benutzerregistrierungsstatus prüfen

Dieser Endpoint ist optional und für Standardintegrationen nicht erforderlich. Nur verwenden, wenn explizit von Wealth Reader angewiesen. Überprüft, ob ein Benutzer im Easytransfer- oder Acumulas-System registriert ist und gibt den eindeutigen Zugangslink für den Benutzer zurück.

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

Einen zuvor registrierten Benutzer widerrufen

Dieser Endpoint ist optional und für Standardintegrationen nicht erforderlich. Nur verwenden, wenn explizit von Wealth Reader angewiesen. Dieser Endpoint ermöglicht das Abmelden eines Benutzers vom Easytransfer- oder Acumulas-Plattformdienst.

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

Dieser Endpoint ist optional und für Standardintegrationen nicht erforderlich. Nur verwenden, wenn explizit von Wealth Reader angewiesen. Wichtig: Um die Batch-Prozessverwaltung auf Wealthreader-Seite zu nutzen, ist eine dedizierte Umgebung erforderlich. Dieser Endpoint ist nicht auf api.wealthreader.com verfügbar. Die unter dem Tag "batch" gruppierten Endpoints ermöglichen die asynchrone Verarbeitung mehrerer Bankverbindungen, im Gegensatz zur synchronen /entities/-Methode. Ideal für die Verarbeitung großer Verbindungsmengen und zur Vermeidung von 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"
}

Allgemeine Statistiken über Batch-Verbindungen abrufen

Dieser Endpoint ist optional. Ruft allgemeine Statistiken über das Verarbeitungsergebnis aller Verbindungen in einem Batch ab.

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

Individuelles Ergebnis einer spezifischen Verbindung innerhalb eines Batch abrufen

Dieser Endpoint ist optional. Ruft das Ergebnis einer spezifischen Verbindung aus dem Batch ab.

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