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));Bank Link作成API:銀行の接続・再接続
Didit の Create a Bank Link エンドポイントは、サーバー側で Bank Link の1回の実行を開始し、ユーザーが銀行を接続するホスト型の 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));url を返します。
すべてのフィールドにはデフォルト値があるため、最小のリクエストは {} に必要な項目を加えたものになります。
返された id はユーザーと紐付けて保存し、結果は Get a bank link または bank.link.completed Webhook で自分で確認してください。
詳細は クイックスタート と Bank Link を参照してください。承認
お客様のアプリケーションのAPIキーです。Business Console の Developers -> API keys から取得できます。プライマリーキーはすべてのアクセス権を持ちます。名前付きキーは範囲を制限できます。リソースごとに none、read、write を指定でき、一部のワークフローや承認済みセッションに限定できます。IPアドレスのリストや有効期限も設定できます。401 はキーが誤っている、取り消されている、または期限切れであることを意味します。403 はキーが送信されていない、そのリソースまたはアクションへのアクセス権がない、またはリクエストがIPリストに含まれないアドレスから送信されたことを意味します。セッションのルートでの404 は、セッションがキーのワークフローまたはステータスの範囲外にあることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLが null で返されます。セッションの書き込み権限がないキーでは、セッションリンクとトークンが null で返されます。詳しくは https://docs.didit.me/console/api-keys を参照してください。
ヘッダー
1回の操作に対して任意で指定する、再試行の安全性を確保するためのキーです。255文字まで指定でき、UUIDも使用できます。同じキー、エンドポイント、クエリ、ボディで繰り返されたリクエストには、最初のレスポンスが同じステータスと同じボディで返され、2回目は実行も課金も行われません。同じキーを別のエンドポイント、クエリ、ボディで使うと 409 idempotency_key_reused が返されます。最初のリクエストがまだ処理中の場合は、Retry-After 付きの 409 idempotency_key_in_progress が返されます。失敗したリクエスト(4xx または 5xx)は保存されないため、同じキーで再送できます。キーは、APIキーとアクセストークンのどちらで呼び出す場合でも、お使いのアプリケーションに属します。詳しくは 再試行と冪等性 を参照してください。
1 - 255ボディ
Bank Linkを作成します。最小のリクエストは {} に必要な項目を加えたものです。すべてのフィールドにデフォルト値があります。
処理の最後にブラウザを遷移させる先。link_id、status、署名付きの state を含みます(表示専用です。Webhookと get_link が正式な結果となります)。サンドボックスアプリケーションでは、localhost、127.0.0.1、[::1] の平文 http アドレス(任意のポートとパス可、認証情報とフラグメントなし)は登録不要です。それ以外のアドレスは 400 redirect_url_not_registered を返します。その他のアドレスの登録はまだ利用できません。redirect_url を指定しない場合、本人はDidit独自の結果ページで処理を完了します。
2048レスポンス
リンクが作成されました。
1人の利用者に対するBank Linkの1回の実行です。銀行に接続する場合、または接続を更新する場合に使用します。リンクはget_linkで自分で確認してください。ブラウザから送られたIDは決して信頼しないでください。