https://verification.didit.me/v3/,与所有独立 API 一样,通过 x-api-key 请求头使用您的应用 API 密钥进行身份验证。
所有写入操作都接受 Idempotency-Key。列表接口接受 limit(默认 100,最大 500),并通过 cursor 继续获取下一页;交易读取接口除外:日期范围读取通过 page_token 继续获取下一页,变更流接受持久的 cursor,并通过 page_token 继续获取下一页。读取操作不产生费用。
错误信息包含 code、message、request_id、field、next_action 和 retry_after:请根据 code 进行分支处理。
除账户核验外,所有操作都需要带有 Bank data 权限的 API 密钥,完全访问权限不包含该权限。
账户核验不使用该权限,它需要具有会话写入权限的 API 密钥,或具有完全访问权限的 API 密钥。
Bank data API 可用于沙盒应用。生产环境应用的调用在正式访问权限公布之前将返回 404。沙盒环境中不收取任何费用。
链接
创建链接
POST /v3/bank/links/获取链接
GET /v3/bank/links/{id}/取消链接
POST /v3/bank/links/{id}/cancel/连接
列出连接
GET /v3/bank/connections/获取连接
GET /v3/bank/connections/{id}/刷新
POST /v3/bank/connections/{id}/refresh/续期
POST /v3/bank/connections/{id}/renew/撤销
POST /v3/bank/connections/{id}/revoke/删除
DELETE /v3/bank/connections/{id}/同步运行记录
GET /v3/bank/connections/{id}/sync-runs/获取同步运行记录
GET /v3/bank/connections/{id}/sync-runs/{sync_id}/账户、余额和交易
列出账户
GET /v3/bank/connections/{id}/accounts/获取账户
GET /v3/bank/accounts/{account_id}/获取余额
GET /v3/bank/accounts/{account_id}/balances/列出交易
GET /v3/bank/accounts/{account_id}/transactions/交易变更流
GET /v3/bank/connections/{id}/transactions/sync/银行与覆盖范围
列出机构
GET /v3/bank/institutions/获取机构
GET /v3/bank/institutions/{id}/获取覆盖范围
GET /v3/bank/coverage/账户核验
POST /v3/bank/account-check/指南
服务端 SDK
七个服务端 SDK 都在bank 资源下提供以下操作,每个操作的方法均以该操作的名称命名,例如 create_link、get_connection、sync_transactions 等。