API docs by Redocly

Wealth Reader (8.1.2)

Download OpenAPI specification:

E-mail: [email protected]

PSD2に基づく規制APIは、銀行口座残高や取引などの特定の金融情報へのアクセスを提供します。ただし、これらのAPIではアクセスできない他の富情報源が存在します。Wealth Reader APIは、規制APIが提供する情報を拡張し、世界中のあらゆるエンティティにおける追加の富源へのリアルタイムアクセスを提供します。Wealth Reader APIの統合に役立つ他の2つの関連ドキュメントがあります。1つはJavascriptウィジェット統合ガイド：https://docs-en.wealthreader.com/ で、もう1つはこのドキュメントに基づく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から別の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"
}

バッチ接続の一般統計を取得する

このエンドポイントはオプションです。バッチ内のすべての接続の処理結果に関する一般的な統計を取得します。

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