メインコンテンツへスキップ
GET
curl
DiditのGet an Institutionエンドポイントは、1つの銀行について、その対応機能と稼働状況を返します。 これまでに観測されたことがない値は、推測値ではなくnullになります。

承認

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
必須

金融機関のIDです。例: es-banco-norte

レスポンス

銀行。

銀行と、その銀行がサポートする機能。値は観測された機能データに基づき毎日更新されます。一度も観測されていない値は推測ではなくnullとなります。

id
string
必須

銀行を示すDidit識別子(安定したスラッグ)。

例:

"es-banco-norte"

name
string
必須
country
string
必須
Pattern: ^[A-Z]{3}$
logo_url
string<uri> | null
必須
timezone
string | null
必須

銀行の日付に使用されるIANAタイムゾーン。

segments
enum<string>[]
必須
利用可能なオプション:
personal,
business
access
enum<string>[]
必須

ongoing は、その銀行で継続的アクセスが有効な場合にのみ表示されます。

利用可能なオプション:
one_time,
ongoing
ongoing_access
boolean
必須

この銀行で継続的なアクセスが利用可能かどうか。

その銀行が許可する最長の同意期間です。日数で示します。観測されていない場合は null です。

history_days_max
integer | null
必須

その銀行が提供する履歴の最大日数です。観測されていない場合は null です。

pending_transactions
boolean | null
必須

銀行が保留中の取引を報告するかどうか。

pending_linkage
boolean | null
必須

銀行が保留中の取引を確定取引に紐付けるかどうか。これにより pending_id が設定されます。

balance_types
enum<string>[]
必須
利用可能なオプション:
booked,
available,
expected
transaction_fields
string[]
必須

銀行が送信することがわかっている取引フィールド。それ以外のフィールドはすべてnullです。

sign_in
enum<string> | null
必須

本人が銀行にサインインする方法。

利用可能なオプション:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
必須

Bank Linkで本人に確認済みのメールアドレスが必要かどうか。

corporate_accounts
boolean | null
必須

法人口座に対応しているかどうか。

bank_account_selection
boolean | null
必須

本人がBank Link内ではなく銀行側で口座を選択するかどうか。

銀行が、過去の履歴を解放するために追加の確認を1回求めるかどうか。

reconfirmation
boolean | null
必須

更新を、銀行へのサインインなしでDiditの画面上で再確認できるかどうか。

sync_frequency_hours
integer | null
必須

銀行がより短い間隔を許可している場合の、自動同期の間隔(時間)。null は日次のデフォルトを意味します。

health
enum<string>
必須
利用可能なオプション:
operational,
degraded,
down
最終更新日 2026年11月22日