curl -X POST 'https://verification.didit.me/v3/bank/links/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"mode": "connect",
"access": "ongoing",
"country": "ESP",
"segment": "business",
"data": [
"accounts",
"balances",
"transactions"
],
"history_from": "2026-01-01",
"consent_days": 180,
"ownership": {
"compare": "none"
},
"end_user": {
"reference": "client-7731",
"email": "ana@example.com"
},
"redirect_url": "https://app.example.com/bank/return",
"allowed_origins": [
"https://app.example.com"
],
"language": "es",
"vendor_data": "client-7731"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.create_link(
mode="connect",
access="ongoing",
country="ESP",
segment="business",
data=["accounts", "balances", "transactions"],
history_from="2026-01-01",
consent_days=180,
ownership={
"compare": "none",
},
end_user={
"reference": "client-7731",
"email": "ana@example.com",
},
redirect_url="https://app.example.com/bank/return",
allowed_origins=["https://app.example.com"],
language="es",
vendor_data="client-7731",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.createLink({
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.CreateLink(ctx, didit.BankCreateLinkParams{
Body: didit.BankLinkCreateRequest{
Mode: didit.Some(didit.BankLinkCreateRequestMode("connect")),
Access: didit.Some(didit.BankLinkCreateRequestAccess("ongoing")),
Country: didit.String("ESP"),
Segment: didit.Some(didit.BankLinkCreateRequestSegment("business")),
Data: didit.Some([]didit.BankLinkCreateRequestData{"accounts", "balances", "transactions"}),
HistoryFrom: didit.String("2026-01-01"),
ConsentDays: didit.Int(180),
Ownership: didit.Some(didit.BankLinkOwnershipRequest{
Compare: didit.Some(didit.BankLinkOwnershipRequestCompare("none")),
}),
EndUser: didit.Some(didit.BankLinkEndUser{
Reference: didit.String("client-7731"),
Email: didit.String("ana@example.com"),
}),
RedirectURL: didit.String("https://app.example.com/bank/return"),
AllowedOrigins: didit.Some([]string{"https://app.example.com"}),
Language: didit.String("es"),
VendorData: didit.String("client-7731"),
},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.time.LocalDate;
import java.util.List;
import me.didit.Didit;
import me.didit.types.BankLinkCreateRequest;
import me.didit.types.BankLinkEndUser;
import me.didit.types.BankLinkOwnershipRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().createLink(BankLinkCreateRequest.builder()
.mode(BankLinkCreateRequest.Mode.of("connect"))
.access(BankLinkCreateRequest.Access.of("ongoing"))
.country("ESP")
.segment(BankLinkCreateRequest.Segment.of("business"))
.data(List.of(BankLinkCreateRequest.Data.of("accounts"), BankLinkCreateRequest.Data.of("balances"), BankLinkCreateRequest.Data.of("transactions")))
.historyFrom(LocalDate.parse("2026-01-01"))
.consentDays(180L)
.ownership(BankLinkOwnershipRequest.builder()
.compare(BankLinkOwnershipRequest.Compare.of("none"))
.build())
.endUser(BankLinkEndUser.builder()
.reference("client-7731")
.email("ana@example.com")
.build())
.redirectUrl("https://app.example.com/bank/return")
.allowedOrigins(List.of("https://app.example.com"))
.language("es")
.vendorData("client-7731")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->createLink([
'mode' => 'connect',
'access' => 'ongoing',
'country' => 'ESP',
'segment' => 'business',
'data' => ['accounts', 'balances', 'transactions'],
'history_from' => '2026-01-01',
'consent_days' => 180,
'ownership' => [
'compare' => 'none',
],
'end_user' => [
'reference' => 'client-7731',
'email' => 'ana@example.com',
],
'redirect_url' => 'https://app.example.com/bank/return',
'allowed_origins' => ['https://app.example.com'],
'language' => 'es',
'vendor_data' => 'client-7731',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.create_link(
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.CreateLinkAsync(new BankLinkCreateRequest
{
Mode = new BankLinkCreateRequestMode("connect"),
Access = new BankLinkCreateRequestAccess("ongoing"),
Country = "ESP",
Segment = new BankLinkCreateRequestSegment("business"),
Data = new BankLinkCreateRequestData[] { "accounts", "balances", "transactions" },
HistoryFrom = "2026-01-01",
ConsentDays = 180,
Ownership = new BankLinkOwnershipRequest
{
Compare = new BankLinkOwnershipRequestCompare("none"),
},
EndUser = new BankLinkEndUser
{
Reference = "client-7731",
Email = "ana@example.com",
},
RedirectUrl = "https://app.example.com/bank/return",
AllowedOrigins = new string[] { "https://app.example.com" },
Language = "es",
VendorData = "client-7731",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"id": "0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40",
"mode": "connect",
"access": "ongoing",
"status": "created",
"url": "https://verify.didit.me/bank/link/example-link-token",
"client_token": "example-client-token",
"expires_at": "2026-11-21T13:00:00Z",
"connection_id": null,
"check_id": null,
"reused": false,
"error": null,
"quote": {
"id": "7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43",
"lines": [
{
"meter": "bank_data_connection_month",
"unit": "connection_month",
"price_usd": "0.9000"
}
],
"fallback_lines": null,
"total_usd": "0.9000",
"valid_until": "2026-11-21T13:00:00Z",
"scopes": [
"accounts",
"balances",
"transactions"
]
},
"vendor_data": "client-7731"
}创建银行链接 API:连接或续期银行
Didit 的创建银行链接端点会在您的服务器上启动一次银行链接流程,并返回用户连接银行所用的托管 URL。
curl -X POST 'https://verification.didit.me/v3/bank/links/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"mode": "connect",
"access": "ongoing",
"country": "ESP",
"segment": "business",
"data": [
"accounts",
"balances",
"transactions"
],
"history_from": "2026-01-01",
"consent_days": 180,
"ownership": {
"compare": "none"
},
"end_user": {
"reference": "client-7731",
"email": "ana@example.com"
},
"redirect_url": "https://app.example.com/bank/return",
"allowed_origins": [
"https://app.example.com"
],
"language": "es",
"vendor_data": "client-7731"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.bank.create_link(
mode="connect",
access="ongoing",
country="ESP",
segment="business",
data=["accounts", "balances", "transactions"],
history_from="2026-01-01",
consent_days=180,
ownership={
"compare": "none",
},
end_user={
"reference": "client-7731",
"email": "ana@example.com",
},
redirect_url="https://app.example.com/bank/return",
allowed_origins=["https://app.example.com"],
language="es",
vendor_data="client-7731",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.bank.createLink({
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Bank.CreateLink(ctx, didit.BankCreateLinkParams{
Body: didit.BankLinkCreateRequest{
Mode: didit.Some(didit.BankLinkCreateRequestMode("connect")),
Access: didit.Some(didit.BankLinkCreateRequestAccess("ongoing")),
Country: didit.String("ESP"),
Segment: didit.Some(didit.BankLinkCreateRequestSegment("business")),
Data: didit.Some([]didit.BankLinkCreateRequestData{"accounts", "balances", "transactions"}),
HistoryFrom: didit.String("2026-01-01"),
ConsentDays: didit.Int(180),
Ownership: didit.Some(didit.BankLinkOwnershipRequest{
Compare: didit.Some(didit.BankLinkOwnershipRequestCompare("none")),
}),
EndUser: didit.Some(didit.BankLinkEndUser{
Reference: didit.String("client-7731"),
Email: didit.String("ana@example.com"),
}),
RedirectURL: didit.String("https://app.example.com/bank/return"),
AllowedOrigins: didit.Some([]string{"https://app.example.com"}),
Language: didit.String("es"),
VendorData: didit.String("client-7731"),
},
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.time.LocalDate;
import java.util.List;
import me.didit.Didit;
import me.didit.types.BankLinkCreateRequest;
import me.didit.types.BankLinkEndUser;
import me.didit.types.BankLinkOwnershipRequest;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.bank().createLink(BankLinkCreateRequest.builder()
.mode(BankLinkCreateRequest.Mode.of("connect"))
.access(BankLinkCreateRequest.Access.of("ongoing"))
.country("ESP")
.segment(BankLinkCreateRequest.Segment.of("business"))
.data(List.of(BankLinkCreateRequest.Data.of("accounts"), BankLinkCreateRequest.Data.of("balances"), BankLinkCreateRequest.Data.of("transactions")))
.historyFrom(LocalDate.parse("2026-01-01"))
.consentDays(180L)
.ownership(BankLinkOwnershipRequest.builder()
.compare(BankLinkOwnershipRequest.Compare.of("none"))
.build())
.endUser(BankLinkEndUser.builder()
.reference("client-7731")
.email("ana@example.com")
.build())
.redirectUrl("https://app.example.com/bank/return")
.allowedOrigins(List.of("https://app.example.com"))
.language("es")
.vendorData("client-7731")
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->bank->createLink([
'mode' => 'connect',
'access' => 'ongoing',
'country' => 'ESP',
'segment' => 'business',
'data' => ['accounts', 'balances', 'transactions'],
'history_from' => '2026-01-01',
'consent_days' => 180,
'ownership' => [
'compare' => 'none',
],
'end_user' => [
'reference' => 'client-7731',
'email' => 'ana@example.com',
],
'redirect_url' => 'https://app.example.com/bank/return',
'allowed_origins' => ['https://app.example.com'],
'language' => 'es',
'vendor_data' => 'client-7731',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.bank.create_link(
mode: "connect",
access: "ongoing",
country: "ESP",
segment: "business",
data: ["accounts", "balances", "transactions"],
history_from: "2026-01-01",
consent_days: 180,
ownership: {
compare: "none",
},
end_user: {
reference: "client-7731",
email: "ana@example.com",
},
redirect_url: "https://app.example.com/bank/return",
allowed_origins: ["https://app.example.com"],
language: "es",
vendor_data: "client-7731"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Bank.CreateLinkAsync(new BankLinkCreateRequest
{
Mode = new BankLinkCreateRequestMode("connect"),
Access = new BankLinkCreateRequestAccess("ongoing"),
Country = "ESP",
Segment = new BankLinkCreateRequestSegment("business"),
Data = new BankLinkCreateRequestData[] { "accounts", "balances", "transactions" },
HistoryFrom = "2026-01-01",
ConsentDays = 180,
Ownership = new BankLinkOwnershipRequest
{
Compare = new BankLinkOwnershipRequestCompare("none"),
},
EndUser = new BankLinkEndUser
{
Reference = "client-7731",
Email = "ana@example.com",
},
RedirectUrl = "https://app.example.com/bank/return",
AllowedOrigins = new string[] { "https://app.example.com" },
Language = "es",
VendorData = "client-7731",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"id": "0b9c4f1e-6a2d-4e8b-9f31-7c5d2e1a8b40",
"mode": "connect",
"access": "ongoing",
"status": "created",
"url": "https://verify.didit.me/bank/link/example-link-token",
"client_token": "example-client-token",
"expires_at": "2026-11-21T13:00:00Z",
"connection_id": null,
"check_id": null,
"reused": false,
"error": null,
"quote": {
"id": "7a3e9c52-1d84-4b06-8f2a-c5e0b9d17a43",
"lines": [
{
"meter": "bank_data_connection_month",
"unit": "connection_month",
"price_usd": "0.9000"
}
],
"fallback_lines": null,
"total_usd": "0.9000",
"valid_until": "2026-11-21T13:00:00Z",
"scopes": [
"accounts",
"balances",
"transactions"
]
},
"vendor_data": "client-7731"
}url。
每个字段都有默认值,因此最简请求就是 {},再加上您需要的字段。
请将返回的 id 与您的用户关联保存,并通过获取银行链接或 bank.link.completed Webhook 自行确认结果。
请参阅快速开始和Bank Link。授权
您的应用 API 密钥,可在 Business Console 的开发者 -> API 密钥中获取。主密钥拥有完全访问权限。命名密钥可以设置范围:可按资源设置无权限、只读或读写,可限定为部分工作流或已批准的会话,可限定为一组 IP 地址,并可设置过期日期。401 表示密钥错误、已被撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或执行该操作,或请求来自其 IP 列表之外的地址;会话相关路由返回 404,表示该会话不在密钥的工作流或状态范围内。没有媒体访问权限的密钥会将图片、视频和 PDF 的 URL 返回为 null;没有会话写入权限的密钥会将会话链接和令牌返回为 null。请参阅 https://docs.didit.me/console/api-keys。
请求头
您为单次操作选择的可选重试安全密钥,最长 255 个字符(可使用 UUID)。使用相同密钥、endpoint、查询参数和请求体重复发送的请求,会返回第一次的响应,状态码和响应体均相同,且不会再次运行或计费。同一密钥若用于其他 endpoint、查询参数或请求体,将返回 409 idempotency_key_reused;若第一个请求仍在处理中,则返回 409 idempotency_key_in_progress 及 Retry-After。失败的请求(任何 4xx 或 5xx)不会被存储,因此您可以使用相同密钥再次发送。无论您使用 API 密钥还是访问 token 调用,密钥都归属于您的应用。请参阅重试与幂等性。
1 - 255请求体
创建 Bank Link。最小请求为 {} 加上您需要的字段:每个字段都有默认值。
响应
链接已创建。
为单个用户执行的一次银行链接运行:连接银行,或续期连接。请使用 get_link 自行确认链接,切勿信任浏览器发送的 ID。