Vai al contenuto principale
GET
curl
L’endpoint Get a Bank Connection di Didit restituisce una connessione con il suo stato, le date del consenso, lo stato della sincronizzazione, i riepiloghi dei conti e il costo. sync.initial_status ti indica quando sono disponibili per la lettura i primi dati, consent.expires_at quando rinnovare e sync.budgets quanti aggiornamenti la banca consente ancora. Vedi Connessioni.

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<uuid>
obbligatorio

L'id della connessione.

Risposta

La connessione.

Il consenso della persona alla tua applicazione per leggere una banca. Un rinnovo mantiene l'id della connessione e tutti gli id dei conti. Una connessione eliminata risponde solo con id, status, status_reason, created_at e erasure: tutti gli altri campi sono assenti e non resta alcun dato di banca, persona o conto.

id
string<uuid>
obbligatorio

Identificativo della connessione.

status
enum<string>
obbligatorio

pending: la prima sincronizzazione è in corso. active: consenso valido. renewal_required: il consenso è terminato o la banca chiede alla persona di accedere di nuovo; i dati restano leggibili così come sono stati sincronizzati l'ultima volta e non viene addebitato nulla. paused: saldo insufficiente per il mese. revoked: accesso interrotto dalla persona, dalla banca o da te. deleted: restano solo id, status, status_reason, created_at ed erasure. failed: la prima sincronizzazione non è mai riuscita.

Opzioni disponibili:
pending,
active,
renewal_required,
paused,
revoked,
deleted,
failed
status_reason
enum<string> | null
obbligatorio

Perché la connessione si trova in questo stato. paused_by_customer è riservato. Per una connessione deleted: deleted_by_customer, consent_lapsed, retention_elapsed o application_deleted.

Opzioni disponibili:
collection_complete,
consent_expired,
consent_lapsed,
bank_requires_sign_in,
revoked_by_end_user,
revoked_by_bank,
revoked_by_customer,
insufficient_balance,
paused_by_customer,
first_sync_failed,
deleted_by_customer,
retention_elapsed,
application_deleted,
null
erasure
object | null
obbligatorio

Impostato dopo delete_connection; altrimenti null.

created_at
string<date-time>
obbligatorio
environment
enum<string>
Opzioni disponibili:
live,
sandbox
access
enum<string>
Opzioni disponibili:
one_time,
ongoing
institution
object

La banca a cui si riferisce una connessione o un link.

segment
enum<string> | null
Opzioni disponibili:
personal,
business,
null
data
enum<string>[]

Gli ambiti accettati dalla persona.

Opzioni disponibili:
accounts,
balances,
transactions

Il consenso della persona per questa connessione.

sync
object

Stato di sincronizzazione di una connessione.

accounts
object[]

Riepilogo di ogni conto della connessione. Leggi il conto completo con get_account.

ownership
object

Il confronto facoltativo del titolare del conto con una persona o un'azienda.

end_user
object
manage_url
string<uri> | null

La pagina di accesso personale della persona. null finché la pagina di accesso non è disponibile.

billing
object

Quanto costa questa connessione. La sandbox non viene mai addebitata.

possible_duplicate_of
string<uuid> | null

Impostato quando questa connessione potrebbe duplicarne un'altra attiva, ma nessun end_user.reference ha consentito una corrispondenza certa.

vendor_data
string | null
updated_at
string<date-time>
Ultima modifica il 22 novembre 2026