API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

Регуляторные API на основе PSD2 предоставляют доступ к определенной финансовой информации, такой как остатки банковских счетов и транзакции. Однако существуют другие источники информации о благосостоянии, которые недоступны через эти API. API Wealth Reader расширяет информацию, предлагаемую регуляторными API, предоставляя доступ в реальном времени к дополнительным источникам благосостояния в любой организации по всему миру. Существует два других связанных документа, которые помогут вам интегрировать API Wealth Reader. Один - это руководство по интеграции виджета Javascript: https://docs-en.wealthreader.com/ а другой - коллекция Postman на основе этой документации. Очень важно: Это определение API адаптировано для клиентов, интегрирующих через Widget, поэтому некоторые параметры, которые не нужны для этого типа интеграции, были опущены, такие как параметры банковской аутентификации, поскольку будет использоваться токен.

Core

Основной API, необходимый для стандартных интеграций

Получает финансовые активы и детали их состава

Получает финансовые активы и детали их состава, включая инвестиционные портфели, состоящие из акций или фондов, кредитные карты, страховки и кредиты. Включает информацию о собственности для каждого актива, а также уникальные идентификаторы, которые облегчают обработку данных. Возможно получение Mock-данных. Проверьте у технической команды, как это сделать.

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

Список типов транзакций

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Запрос токенов, связанных с api_key

Используйте этот метод для запроса всех токенов, связанных с определённым api_key. Результаты возвращаются блоками по 500 токенов на страницу.

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

Отозвать токен

Этот метод позволяет отозвать существующий токен для деавторизации будущих запросов на доступ к 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."
}

Переназначить токен на другой api_key

Этот метод позволяет переназначить токен с одного api_key на другой.

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

Добавить новый домен

Добавляет связь между доменом, который будет размещать виджет, и целевым webhook. По соображениям безопасности операции редактирования и удаления возможны только по запросу в службу поддержки

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

Список кодов ошибок

Список кодов ошибок. Обратите особое внимание на то, что не все коды ошибок должны обрабатываться вашим приложением одинаково. При ошибке неправильного пароля не следует повторять вызов с теми же параметрами, но при ошибке, указывающей на то, что сущность находится на обслуживании, можно повторить попытку. Запросите техническую сессию с нашей командой для решения любых вопросов по управлению ошибками.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Список кодов предупреждений

Список кодов предупреждений.

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

Response language

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Advanced

Дополнительные конечные точки, не требуемые для стандартных интеграций. Использовать только при явном указании Wealth Reader.

Получает список поддерживаемых организаций

Получает список поддерживаемых организаций и информацию, необходимую для рисования формы входа в систему организации.

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

Проверка владения банковским счётом через IBAN

Эта конечная точка является необязательной и не требуется для стандартных интеграций. Использовать только при явном указании Wealth Reader. Позволяет проверить, является ли физическое или юридическое лицо владельцем определённого банковского счёта, используя IBAN и идентификационные данные предполагаемого владельца.

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

Зарегистрировать нового пользователя

Эта конечная точка является необязательной и не требуется для стандартных интеграций. Использовать только при явном указании Wealth Reader. Эта конечная точка позволяет зарегистрировать пользователя либо на платформе передачи портфеля Easytransfer, либо в инструменте отчётности 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"

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

Проверить статус регистрации пользователя

Эта конечная точка является необязательной и не требуется для стандартных интеграций. Использовать только при явном указании Wealth Reader. Проверяет, зарегистрирован ли пользователь в системе Easytransfer или Acumulas, и возвращает уникальную ссылку доступа для пользователя.

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

Отозвать ранее зарегистрированного пользователя

Эта конечная точка является необязательной и не требуется для стандартных интеграций. Использовать только при явном указании Wealth Reader. Эта конечная точка позволяет отменить регистрацию пользователя в сервисе платформы Easytransfer или 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"
}

Пакетная загрузка соединений

Эта конечная точка является необязательной и не требуется для стандартных интеграций. Использовать только при явном указании Wealth Reader. Конечные точки, сгруппированные под тегом "batch", позволяют обрабатывать несколько банковских соединений асинхронно, в отличие от синхронного метода /entities/. Идеально для обработки больших объёмов соединений и избежания таймаутов.

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

Получить общую статистику по 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": {
    }
}

Получить индивидуальный результат конкретного соединения в пакете

Эта конечная точка является необязательной. Получает результат конкретного соединения из пакета.

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