メインコンテンツへスキップ
POST
curl
Didit の Create a Bank Link エンドポイントは、サーバー側で Bank Link の 1 回分の処理を開始し、銀行への接続または接続の更新を行うためのホスト型の url を返します。 すべてのフィールドにはデフォルト値があるため、最小のリクエストは {} に必要な項目を加えたものになります。 返された id はユーザーと紐付けて保存し、結果は Get a bank link または bank.link.completed Webhook で自分で確認してください。 詳細は クイックスタート と Bank Link を参照してください。

承認

x-api-key
string
header
必須

お客様のアプリケーションの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 を参照してください。

ヘッダー

Idempotency-Key
string

1回の操作に対して任意で指定する、再試行の安全性を確保するためのキーです。255文字まで指定でき、UUIDも使用できます。同じキー、エンドポイント、クエリ、ボディで繰り返されたリクエストには、最初のレスポンスが同じステータスと同じボディで返され、2回目は実行も課金も行われません。同じキーを別のエンドポイント、クエリ、ボディで使うと 409 idempotency_key_reused が返されます。最初のリクエストがまだ処理中の場合は、Retry-After 付きの 409 idempotency_key_in_progress が返されます。失敗したリクエスト(4xx または 5xx)は保存されないため、同じキーで再送できます。キーは、APIキーとアクセストークンのどちらで呼び出す場合でも、お使いのアプリケーションに属します。詳しくは 再試行と冪等性 を参照してください。

Required string length: 1 - 255

ボディ

application/json

Bank Linkを作成します。最小のリクエストは {} に必要な項目を加えたものです。すべてのフィールドにデフォルト値があります。

mode
enum<string>
デフォルト:connect

connect(デフォルト)は新しい接続を作成します。renew には connection_id が必要で、その接続の設定を再利用します。

利用可能なオプション:
connect,
renew
connection_id
string<uuid>

更新する接続。mode: renew の場合のみ。

access
enum<string>
デフォルト:one_time

one_time(デフォルト)はデータを一度だけ読み取ります。ongoing は、同意が終了するか誰かが停止するまでアクセスを維持します。institution_id を設定した場合、アクセスを維持できない銀行には、画面を表示する前に 400 ongoing_access_not_available を返します。設定しない場合、銀行選択画面には対応している銀行のみが表示されます。

利用可能なオプション:
one_time,
ongoing
country
string

任意。省略すると、本人は申請で有効になっている国から選択します。Bank Link が対応している国である必要があります。ZZZ を含め、それ以外の値は field: country を指定した 400 invalid_request を返します。空のリクエストボディも有効です。

Pattern: ^[A-Z]{3}$
institution_id
string

任意。list_institutions から取得した、事前に選択する銀行。銀行の選択画面はスキップされます。

Maximum string length: 64
segment
enum<string>
デフォルト:any

ピッカーを絞り込み、銀行がログインを分けている場合にどのログインを開くかを銀行に伝えます。デフォルトは any。

利用可能なオプション:
personal,
business,
any
data
enum<string>[]

読み取る対象。accounts は常に含まれます:名称、種類、通貨、識別子、および銀行が共有する場合は口座名義人名。デフォルトは ["accounts"]。

Maximum array length: 3
利用可能なオプション:
accounts,
balances,
transactions
history_days
integer
デフォルト:90

取得する取引履歴の日数(1〜365、既定値は90)。銀行はこれより少ない期間しか提供しない場合があります。各口座は提供した期間をhistory_coverageで報告します。history_fromと同時に送信することはできません。

必須範囲: 1 <= x <= 365
history_from
string<date>

history_days の代わりに取得する履歴の開始日です。history_days と同時に指定することはできません。両方を指定すると 400 history_window_ambiguous が返されます。365日より前の日付、または未来の日付の場合は 400 window_not_available が返されます。

extended_history
enum<string>
デフォルト:standard

allow_extra_auth を指定すると、追加の確認を一度求める銀行でも、過去の履歴を提供できます。

利用可能なオプション:
standard,
allow_extra_auth

継続的なアクセスのみ。銀行にアクセスを開いたままにするよう依頼する日数(1日以上)。デフォルトは銀行が許可する最長期間です。接続は、銀行が実際に付与した日付を consent.expires_at で返します。access: one_time の場合は、field: consent_days を指定した 400 invalid_request を返します。

必須範囲: 1 <= x <= 32767
ownership
object

任意。口座名義人を個人または法人と照合する設定。

end_user
object

口座を接続する個人または法人です。

redirect_url
string<uri>

処理の最後にブラウザを遷移させる先。link_id、status、署名付きの state を含みます(表示専用です。Webhookと get_link が正式な結果となります)。サンドボックスアプリケーションでは、localhost、127.0.0.1、[::1] の平文 http アドレス(任意のポートとパス可、認証情報とフラグメントなし)は登録不要です。それ以外のアドレスは 400 redirect_url_not_registered を返します。その他のアドレスの登録はまだ利用できません。redirect_url を指定しない場合、本人はDidit独自の結果ページで処理を完了します。

Maximum string length: 2048
allowed_origins
string<uri>[]

受け付けますが、現在は使用されません。Didit の埋め込み型Bank Linkのために予約されており、まだ提供されていません。HTTPSオリジン、最大50件。

Maximum array length: 50
language
string

任意。es や pt-BR などの言語コード。省略した場合はブラウザの言語が使われます。

Maximum string length: 16
Pattern: ^[A-Za-z]{2,3}(-[A-Za-z0-9]{2,8})?$
vendor_data
string

あなた独自の参照情報。リンクと接続に返されます。

Maximum string length: 255
expires_in
integer
デフォルト:3600

リンクの有効期間(秒)。300~86400。既定値は3600。

必須範囲: 300 <= x <= 86400
duplicates
enum<string>
デフォルト:reuse

reuse(デフォルト)は、すでに共有しているアカウントに解決されるリンクを、その接続の更新として完了させます。allow は、独立した2つ目の接続を作成します。

利用可能なオプション:
reuse,
allow
allow_one_time_fallback
boolean
デフォルト:false

ongoing の場合に、銀行がアクセスを維持できないときでも、本人が自分の画面で縮小されたアクセスを確認したうえで、一回限りの読み取りで続行できるようにします。見積もりにはその費用が表示されます。access: ongoing の場合のみ有効です。一回限りのアクセスの場合は、field: allow_one_time_fallback を伴う 400 invalid_request を返します。

accept_reduced_grant
boolean
デフォルト:false

銀行または本人が依頼より少ない範囲しか許可しない場合は、リンクを完了させ、許可されたスコープ分のみ課金します。それ以外の場合、リンクは reduced_grant を伴って failed で終了し、課金は発生しません。

sandbox
object

サンドボックスアプリケーションのみが対象です。Didit Test Bank の顧客を選択します。本番環境のアプリケーションでは無視されます。

レスポンス

リンクが作成されました。

1人の利用者に対するBank Linkの1回の実行です。銀行に接続する場合、または接続を更新する場合に使用します。リンクはget_linkで自分で確認してください。ブラウザから送られたIDは決して信頼しないでください。

id
string<uuid>
必須

リンクの識別子。

mode
enum<string>
必須
利用可能なオプション:
connect,
renew
access
enum<string>
必須
利用可能なオプション:
one_time,
ongoing
status
enum<string>
必須

リンクの状態です。completed、cancelled、expired、failed は最終状態です。

利用可能なオプション:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
必須

利用者を誘導するホスト型ページです。リンクの作成時にのみ返されます。トークンは保存されないため、後続の読み取りでは null になります。

client_token
string | null
必須

Diditの埋め込み型Bank Link用のトークンです。まだリリースされていないため、現時点ではurlを開いてください。リンク作成時にのみ返され、以降の読み取りではnullになります。用途は1つだけで有効期間は短く、個人データは含まれません。絶対にログに記録しないでください。

expires_at
string<date-time>
必須

未使用のリンクが無効になる日時。

connection_id
string<uuid> | null
必須

status が completed になると、このリンクによって作成または更新された接続。

check_id
string<uuid> | null
必須

ownership.compare に none 以外を指定した場合の、このリンクの所有構造の判定結果です。

reused
boolean
必須

本人がこれらの口座をすでに正確に共有している場合(duplicates: reuse)、リンクは既存の接続の更新として完了し、その際 true になります。二重に課金されることはありません。

error
object | null
必須

status が failed の場合に、リンクが失敗した理由。それ以外は null。

quote
object
必須

リンクの料金。作成時に固定されます。請求される料金は見積もりの料金です。読み取りでは課金されません。

vendor_data
string | null
必須

リクエストで指定したあなたの参照情報。

最終更新日 2026年11月22日