Vai al contenuto principale
GET
curl
L’endpoint Get a Bank Link di Didit restituisce lo stato di un link e, una volta completato, il suo connection_id e il suo check_id. Richiamalo dal tuo server dopo onSuccess o quando si verifica bank.link.completed: non fidarti mai di un ID del link inviato dal browser. Un link fallito restituisce 200 con status: failed e un error con un codice come duplicate_conflict o reduced_grant.

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 del link.

Risposta

Il link.

Un'esecuzione di Bank Link per una persona: collega una banca oppure rinnova una connessione. Conferma tu stesso un link con get_link: non fidarti mai di un id inviato dal browser.

id
string<uuid>
obbligatorio

Identificativo del link.

mode
enum<string>
obbligatorio
Opzioni disponibili:
connect,
renew
access
enum<string>
obbligatorio
Opzioni disponibili:
one_time,
ongoing
status
enum<string>
obbligatorio

Stato del link. completed, cancelled, expired e failed sono stati definitivi.

Opzioni disponibili:
created,
opened,
connecting,
completed,
cancelled,
expired,
failed
url
string<uri> | null
obbligatorio

La pagina ospitata a cui inviare la persona. Restituita solo alla creazione del link; null nelle letture successive, perché il token non viene memorizzato.

client_token
string | null
obbligatorio

Il token per il Bank Link incorporato di Didit, che non è ancora disponibile: apri url oggi. Viene restituito solo alla creazione del link; null nelle letture successive. Ha uno scopo unico e una validità breve. Non contiene dati personali. Non registrarlo mai nei log.

expires_at
string<date-time>
obbligatorio

Quando un link non riscattato smette di funzionare.

connection_id
string<uuid> | null
obbligatorio

La connessione creata o rinnovata da questo link, quando status è completed.

check_id
string<uuid> | null
obbligatorio

L'esito dell'assetto proprietario di questo link, quando ha richiesto ownership.compare diverso da none.

reused
boolean
obbligatorio

true quando il link è stato completato come rinnovo di una connessione esistente, perché la persona condivide già esattamente questi conti (duplicates: reuse). Nessun importo viene addebitato due volte.

error
object | null
obbligatorio

Perché il link non è riuscito, quando status è failed. Altrimenti null.

quote
object
obbligatorio

Il prezzo di un link, fissato al momento della creazione. Il costo addebitato è quello del preventivo. Le letture non addebitano nulla.

vendor_data
string | null
obbligatorio

Il tuo riferimento della richiesta.

Ultima modifica il 22 novembre 2026