API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

As APIs regulatórias baseadas em PSD2 fornecem acesso a certas informações financeiras, como saldos de contas bancárias e transações. No entanto, existem outras fontes de informações patrimoniais que não são acessíveis através dessas APIs. A API Wealth Reader estende as informações oferecidas pelas APIs regulatórias, fornecendo acesso em tempo real a fontes patrimoniais adicionais em qualquer entidade mundial. Existem dois outros documentos relacionados que irão ajudá-lo a integrar a API Wealth Reader. Um é o guia de integração do widget Javascript: https://docs-en.wealthreader.com/ e o outro é uma coleção Postman baseada nesta documentação. Muito importante: Esta definição de API é adaptada para clientes que integram via Widget, portanto alguns parâmetros que não são necessários para este tipo de integração foram omitidos, como os parâmetros de autenticação bancária, pois um token será usado.

Core

API principal necessária para integrações padrão

Obtém ativos financeiros e detalhes de sua composição

Obtém ativos financeiros e detalhes de sua composição incluindo carteiras de investimento compostas por ações ou fundos, cartões de crédito, seguros e empréstimos. Inclui informações de propriedade para cada ativo bem como identificadores únicos que facilitam o processamento de dados. É possível obter dados Mock. Verifique com a equipe técnica como fazer isso.

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

Lista de tipos de transação

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Consultar tokens associados a uma api_key

Use este método para consultar todos os tokens vinculados a uma api_key específica. Os resultados são retornados em blocos de 500 tokens por página.

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

Revogar um token

Este método permite revogar um token existente para desautorizar futuras solicitações de acesso à API.

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

Reatribuir um token a uma api_key diferente

Este método permite reatribuir um token de uma api_key para outra.

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

Adicionar um novo domínio

Adiciona a associação entre o domínio que hospedará o widget e o webhook de destino. Por razões de segurança, as operações de edição e exclusão só são possíveis solicitando-as ao suporte

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

Lista de códigos de erro

Lista de códigos de erro. Preste atenção especial ao fato de que nem todos os códigos de erro devem receber o mesmo tratamento da sua aplicação. Para um erro de senha incorreta, você não deve tentar novamente a chamada com os mesmos parâmetros, mas para um erro indicando que a entidade está em manutenção, você pode tentar novamente. Solicite uma sessão técnica com nossa equipe para resolver quaisquer questões sobre gerenciamento de erros.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Lista de códigos de aviso

Lista de códigos de aviso.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Endpoints opcionais não necessários para integrações padrão. Use apenas se explicitamente instruído pela Wealth Reader.

Obtém a lista de entidades suportadas

Obtém a lista de entidades suportadas e as informações necessárias para desenhar o formulário de login da entidade.

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

Verificar titularidade de conta bancária via IBAN

Este endpoint é opcional e não é necessário para integrações padrão. Use apenas se explicitamente instruído pela Wealth Reader. Permite verificar se uma pessoa física ou jurídica é titular de uma conta bancária específica usando o IBAN e os dados de identificação do suposto 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

Response samples

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

Registrar um novo usuário

Este endpoint é opcional e não é necessário para integrações padrão. Use apenas se explicitamente instruído pela Wealth Reader. Este endpoint permite registrar um usuário na plataforma de transferência de portfólio Easytransfer ou na ferramenta de relatórios Acumulas, com base em um identificador único.

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

Verificar status de registro do usuário

Este endpoint é opcional e não é necessário para integrações padrão. Use apenas se explicitamente instruído pela Wealth Reader. Verifica se um usuário está registrado no sistema Easytransfer ou Acumulas e retorna o link de acesso único para o usuário.

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

Revogar um usuário previamente registrado

Este endpoint é opcional e não é necessário para integrações padrão. Use apenas se explicitamente instruído pela Wealth Reader. Este endpoint permite cancelar o registro de um usuário do serviço da plataforma 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"
}

Carregamento de conexões em lote

Este endpoint é opcional e não é necessário para integrações padrão. Use apenas se explicitamente instruído pela Wealth Reader. Os endpoints agrupados sob a tag "batch" permitem processar múltiplas conexões bancárias de forma assíncrona, ao contrário do método /entities/ que é síncrono. Ideal para processar grandes volumes de conexões e evitar 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"
}

Obter estatísticas gerais sobre conexões batch

Este endpoint é opcional. Recupera estatísticas gerais sobre o resultado do processamento de todas as conexões em um lote.

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

Obter resultado individual de uma conexão específica dentro de um batch

Este endpoint é opcional. Recupera o resultado de uma conexão específica do lote.

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