Skip to main content
GET
curl
Didit’s Get an Institution endpoint returns one bank with its capabilities and health. A value never observed is null, not a guess.

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is wrong, revoked or expired; 403 means no key was sent, the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Path Parameters

id
string
required

The institution id, for example es-banco-norte.

Response

The bank.

A bank and what it supports. Values come from observed capability data, refreshed daily; a value never observed is null, not a guess.

id
string
required

Didit's identifier of the bank, a stable slug.

Example:

"es-banco-norte"

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

IANA time zone the bank's dates are in.

segments
enum<string>[]
required
Available options:
personal,
business
access
enum<string>[]
required

ongoing is listed only where ongoing access is switched on for the bank.

Available options:
one_time,
ongoing
ongoing_access
boolean
required

Whether ongoing access is available at this bank.

The longest consent the bank allows, in days. null when not observed.

history_days_max
integer | null
required

The deepest history the bank delivers, in days. null when not observed.

pending_transactions
boolean | null
required

Whether the bank reports pending transactions.

pending_linkage
boolean | null
required

Whether the bank links a pending transaction to its booked one, which is what sets pending_id.

balance_types
enum<string>[]
required
Available options:
booked,
available,
expected
transaction_fields
string[]
required

The transaction fields the bank is known to send. Every other field is null.

sign_in
enum<string> | null
required

How the person signs in at the bank.

Available options:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
required

Whether Bank Link needs a verified email address for the person.

corporate_accounts
boolean | null
required

Whether business accounts are supported.

bank_account_selection
boolean | null
required

Whether the person picks the accounts at the bank instead of in Bank Link.

Whether the bank asks for one more confirmation to release older history.

reconfirmation
boolean | null
required

Whether a renewal can be reconfirmed on Didit's screen without a bank sign-in.

sync_frequency_hours
integer | null
required

Hours between automatic syncs where the bank allows a faster cadence. null means the daily default.

health
enum<string>
required
Available options:
operational,
degraded,
down
Last modified on November 22, 2026