メインコンテンツへスキップ
GET
curl
Didit の「銀行リンクの取得」エンドポイントは、リンクのステータスを返します。リンクが完了している場合は、その connection_id と check_id も返します。 onSuccess の後、または bank.link.completed のタイミングで、サーバーから本エンドポイントを呼び出してください。ブラウザから送信されたリンクIDは、決して信頼しないでください。 失敗したリンクは 200 と status: failed で返され、error には duplicate_conflict や reduced_grant などのコードが含まれます。

承認

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 を参照してください。

パスパラメータ

id
string<uuid>
必須

リンクのIDです。

レスポンス

リンクです。

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日