API docs by Redocly

Wealth Reader (8.1.3)

Download OpenAPI specification:

E-mail: [email protected]

Les API réglementaires basées sur PSD2 donnent accès à certaines informations financières telles que les soldes des comptes bancaires et les transactions. Cependant, il existe d'autres sources d'informations sur la richesse qui ne sont pas accessibles via ces API. L'API Wealth Reader étend les informations offertes par les API réglementaires en fournissant un accès en temps réel à des sources de richesse supplémentaires dans toute entité mondiale. Il existe deux autres documents connexes qui vous aideront à intégrer l'API Wealth Reader. L'un est le guide d'intégration du widget Javascript : https://docs-en.wealthreader.com/ et l'autre est une collection Postman basée sur cette documentation. Très important : Cette définition d'API est adaptée pour les clients intégrant via Widget, donc certains paramètres qui ne sont pas nécessaires pour ce type d'intégration ont été omis, tels que les paramètres d'authentification bancaire, car un token sera utilisé.

Core

API principale requise pour les intégrations standard

Récupère les actifs financiers et les détails de leur composition

Récupère les actifs financiers et les détails de leur composition incluant les portefeuilles d'investissement composés d'actions ou de fonds, cartes de crédit, assurances et prêts. Inclut les informations de propriété pour chaque actif ainsi que des identifiants uniques qui facilitent le traitement des données. Il est possible d'obtenir des données Mock. Vérifiez auprès de l'équipe technique comment procéder.

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

Identifie le client dans le service

code
string

Nom de l'entité. La liste complète est disponible avec GET

token
string

Identifie les identifiants gardés. Le flux par lequel le token a été obtenu est décrit dans le document 'Guide d'intégration du Widget'. Les utilisateurs Mock suivants sont disponibles: MOCKDATA, réponse OK; MOCKOTP, réponse avec défi OTP; MOCKLOGINKO, réponse avec erreur de login

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

Liste des types de produits dont les informations doivent être récupérées. Accepte plusieurs valeurs séparées par des virgules.

only_balances
boolean
Default: false

Indique s'il faut obtenir uniquement les soldes des produits au lieu de toutes les informations disponibles. Valeur par défaut: false.

date_from
string <date>

Date à partir de laquelle les transactions sont demandées, au format AAAA-MM-JJ. Doit être une date antérieure à aujourd'hui.

date_to
string <date>

Ceci s'applique uniquement pour restreindre par dates futures pour les produits loan et confirming, au format AAAA-MM-JJ. La date doit être postérieure à aujourd'hui

required_products_schema
string

Schéma des produits requis. Indique les comptes ou cartes dont les données sont souhaitées, avec des configurations supplémentaires.

add_pdf_from_uuids
string

Accepte les uuids de transactions séparés par des virgules. Paramètre pris en compte uniquement si product_types est ALL ou inclut accounts. Ajoute le document PDF associé à chacune des transactions bancaires demandées.

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 des types de transaction

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Interroger les tokens associés à une api_key

Utilisez cette méthode pour interroger tous les tokens liés à une api_key spécifique. Les résultats sont retournés par blocs de 500 tokens par page.

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

api_key pour identifier le client dans le service

page
number

Spécifiez le numéro de page que vous souhaitez récupérer. Chaque page contient jusqu'à 500 tokens. Si non fourni, la valeur par défaut est 1.

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Révoquer un token

Cette méthode permet de révoquer un token existant pour désautoriser les futures demandes d'accès à l'API.

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

Identifie le client dans le service

token
string

Jeton à révoquer.

Responses

Response samples

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

Réattribuer un token à une api_key différente

Cette méthode permet de réattribuer un token d'une api_key à une autre.

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

api_key à partir de laquelle réattribuer le jeton.

api_key_target
string

api_key vers lequel réattribuer le jeton.

token
string

Jeton à réattribuer.

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

Ajouter un nouveau domaine

Ajoute l'association entre le domaine qui hébergera le widget et le webhook de destination. Pour des raisons de sécurité, les opérations de modification et de suppression ne sont possibles qu'en les demandant au 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

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 des codes d'erreur

Liste des codes d'erreur. Faites particulièrement attention au fait que tous les codes d'erreur ne doivent pas recevoir le même traitement de votre application. Pour une erreur de mot de passe incorrect, vous ne devez pas réessayer l'appel avec les mêmes paramètres, mais pour une erreur indiquant que l'entité est en maintenance, vous pouvez réessayer. Demandez une session technique avec notre équipe pour résoudre toute question sur la gestion des erreurs.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Liste des codes d'avertissement

Liste des codes d'avertissement.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Points de terminaison optionnels non requis pour les intégrations standard. Utiliser uniquement si Wealth Reader l'indique explicitement.

Récupère la liste des entités prises en charge

Récupère la liste des entités prises en charge et les informations nécessaires pour dessiner le formulaire de connexion de l'entité.

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

Vérifier la titularité d'un compte bancaire via IBAN

Ce endpoint est optionnel et non requis pour les intégrations standard. À utiliser uniquement sur instruction explicite de Wealth Reader. Permet de vérifier si une personne physique ou morale est titulaire d'un compte bancaire spécifique en utilisant l'IBAN et les données d'identification du titulaire présumé.

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

Enregistrer un nouvel utilisateur

Ce endpoint est optionnel et non requis pour les intégrations standard. À utiliser uniquement sur instruction explicite de Wealth Reader. Ce endpoint permet d'enregistrer un utilisateur soit sur la plateforme de transfert de portefeuille, Easytransfer, soit sur l'outil de reporting, Acumulas, basé sur un identifiant unique.

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

Vérifier le statut d'inscription de l'utilisateur

Ce endpoint est optionnel et non requis pour les intégrations standard. À utiliser uniquement sur instruction explicite de Wealth Reader. Vérifie si un utilisateur est enregistré dans le système Easytransfer ou Acumulas et renvoie le lien d'accès unique pour l'utilisateur.

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

Révoquer un utilisateur précédemment enregistré

Ce endpoint est optionnel et non requis pour les intégrations standard. À utiliser uniquement sur instruction explicite de Wealth Reader. Ce endpoint permet de désinscrire un utilisateur du service de la plateforme Easytransfer ou 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"
}

Chargement de connexions par lot

Ce endpoint est optionnel et non requis pour les intégrations standard. À utiliser uniquement sur instruction explicite de Wealth Reader. Important : Pour utiliser la gestion des processus batch du côté de Wealthreader, un environnement dédié est nécessaire. Ce endpoint n'est pas disponible sur api.wealthreader.com. Les endpoints regroupés sous le tag "batch" permettent de traiter plusieurs connexions bancaires de manière asynchrone, contrairement à la méthode /entities/ qui est synchrone. Idéal pour traiter de grands volumes de connexions et éviter les 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"
}

Obtenir les statistiques générales des connexions batch

Ce endpoint est optionnel. Récupère les statistiques générales sur le résultat du traitement de toutes les connexions d'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": {
    }
}

Obtenir le résultat individuel d'une connexion spécifique dans un batch

Ce endpoint est optionnel. Récupère le résultat d'une connexion spécifique du 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": {
    }
}