Vai al contenuto principale
GET
curl
L’endpoint “Get an Institution” di Didit restituisce una singola banca con le sue funzionalità e il suo stato. Un valore mai osservato è null, non una supposizione.

Autorizzazioni

x-api-key
string
header
obbligatorio

La chiave API della tua applicazione, da Developers -> API keys nella Business Console. La chiave primaria ha accesso completo. Una chiave con nome può avere ambiti limitati: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o solo alle sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 significa che la chiave è errata, revocata o scaduta; 403 significa che non è stata inviata alcuna chiave, che la chiave non ha accesso a questa risorsa o azione, oppure che la richiesta proviene da un indirizzo esterno alla sua lista IP; 404 su una route di sessione significa che la sessione è al di fuori dei workflow o degli stati consentiti alla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permesso di scrittura sulle sessioni riceve i link e i token delle sessioni come null. Vedi https://docs.didit.me/console/api-keys.

Parametri del percorso

id
string
obbligatorio

L'ID dell'istituto, per esempio es-banco-norte.

Risposta

La banca.

Una banca e le funzionalità che supporta. I valori provengono da dati sulle capacità osservati, aggiornati ogni giorno; un valore mai osservato è null, non una supposizione.

id
string
obbligatorio

Identificatore Didit della banca, uno slug stabile.

Esempio:

"es-banco-norte"

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

Fuso orario IANA in cui sono espresse le date della banca.

segments
enum<string>[]
obbligatorio
Opzioni disponibili:
personal,
business
access
enum<string>[]
obbligatorio

ongoing è elencato solo dove l'accesso continuo è attivo per la banca.

Opzioni disponibili:
one_time,
ongoing
ongoing_access
boolean
obbligatorio

Se l'accesso continuo è disponibile presso questa banca.

Il consenso più lungo consentito dalla banca, in giorni. null se non rilevato.

history_days_max
integer | null
obbligatorio

Il periodo storico più ampio che la banca fornisce, in giorni. null se non rilevato.

pending_transactions
boolean | null
obbligatorio

Se la banca riporta le transazioni in sospeso.

pending_linkage
boolean | null
obbligatorio

Se la banca collega una transazione in sospeso alla transazione contabilizzata, cosa che imposta pending_id.

balance_types
enum<string>[]
obbligatorio
Opzioni disponibili:
booked,
available,
expected
transaction_fields
string[]
obbligatorio

I campi della transazione che, a quanto risulta, la banca invia. Ogni altro campo è null.

sign_in
enum<string> | null
obbligatorio

Come la persona accede alla banca.

Opzioni disponibili:
redirect,
app_approval,
credentials,
null
requires_end_user_email
boolean | null
obbligatorio

Se Bank Link richiede alla persona un indirizzo email verificato.

corporate_accounts
boolean | null
obbligatorio

Se sono supportati i conti aziendali.

bank_account_selection
boolean | null
obbligatorio

Se la persona sceglie i conti presso la banca anziché in Bank Link.

Se la banca chiede un'ulteriore conferma per sbloccare la cronologia più vecchia.

reconfirmation
boolean | null
obbligatorio

Se un rinnovo può essere riconfermato sulla schermata di Didit senza un accesso alla banca.

sync_frequency_hours
integer | null
obbligatorio

Ore tra una sincronizzazione automatica e l'altra, dove la banca consente una cadenza più frequente. null indica il valore giornaliero predefinito.

health
enum<string>
obbligatorio
Opzioni disponibili:
operational,
degraded,
down
Ultima modifica il 22 novembre 2026