Vai al contenuto principale
GET
curl
Questo endpoint restituisce il webhook a livello di applicazione, introdotto prima che esistessero le destinazioni, insieme all’elenco delle destinazioni. Didit consegna i webhook alle tue destinazioni webhook, ciascuna firmata con il proprio secret_shared_key. I campi di primo livello webhook_url, webhook_version e secret_shared_key vengono usati solo finché non è abilitata alcuna destinazione, e in tal caso solo per status.updated e data.updated.
La risposta contiene tutti i segreti di firma della tua applicazione. Non inserirla nei log né nel codice lato client.
Per modificare queste impostazioni, usa Aggiorna la configurazione dei webhook. Per la verifica della firma e i payload, consulta la guida ai webhook. Per i campi di conservazione dei dati, consulta Conservazione dei dati.

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 un ambito definito: nessuno, lettura o scrittura per risorsa, limitata ad alcuni workflow o a sessioni approvate, a un elenco di indirizzi IP e a una data di scadenza. 401 indica che la chiave è errata, revocata o scaduta; 403 indica 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 non incluso nel suo elenco IP; 404 su una route di sessione indica che la sessione non rientra nei workflow o negli stati previsti dalla chiave. Una chiave senza accesso ai media riceve gli URL di immagini, video e PDF come null, e una chiave senza permessi di scrittura sulle sessioni riceve link e token di sessione come null. Consulta https://docs.didit.me/console/api-keys.

Risposta

La configurazione del webhook.

Configurazione dei webhook a livello di applicazione, policy di conservazione e host di ritorno del wallet Digital ID, con ogni destinazione webhook.

webhook_url
string<uri> | null
obbligatorio

URL del webhook a livello di applicazione (legacy). Didit invia le notifiche a questo URL solo se l'applicazione non ha destinazioni abilitate, e in tal caso invia solo status.updated e data.updated. Ogni operazione di creazione, aggiornamento o eliminazione di una destinazione lo imposta sull'URL della destinazione abilitata più vecchia, oppure su null se nessuna è abilitata.

webhook_version
enum<string>
obbligatorio

Versione del payload del webhook_url legacy. Ciascuna destinazione ha il proprio webhook_version.

Opzioni disponibili:
v1,
v2,
v3
secret_shared_key
string
obbligatorio

Segreto di firma a livello di applicazione (token URL-safe di 43 caratteri). Firma solo le consegne al webhook_url legacy; ciascuna destinazione firma con la propria secret_shared_key. I chiamanti autenticati tramite chiave API lo ricevono sempre per intero; gli utenti della Console privi dell'autorizzazione read:webhooks ricevono una stringa vuota.

capture_method
enum<string>
obbligatorio

Impostazione legacy dell'applicazione. Il flusso di verifica non la legge: le opzioni di acquisizione sono configurate per workflow.

Opzioni disponibili:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null
obbligatorio

Finestra di eliminazione automatica. Le sessioni di verifica degli utenti create più di questo numero di mesi fa (un mese corrisponde a 30 giorni) vengono eliminate automaticamente e tale eliminazione è irreversibile. null indica che le sessioni non vengono mai eliminate automaticamente. Consulta Conservazione dei dati.

Intervallo richiesto: 1 <= x <= 120
face_retention_policy
enum<string>
obbligatorio

Cosa succede all'embedding facciale di una sessione quando la sessione viene eliminata. delete_with_session (predefinito) lo elimina con la sessione. retain_until_user_deleted è l'opzione facoltativa per la conservazione del modello biometrico: un modello biometrico privo di immagini collegato all'Utente viene gestito separatamente fino al termine del periodo di conservazione, all'eliminazione dell'Utente o alla sua eliminazione definitiva.

Opzioni disponibili:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null
obbligatorio

Periodo di conservazione, in giorni, dei modelli biometrici secondo retain_until_user_deleted. Obbligatorio quando tale criterio è impostato.

Intervallo richiesto: 1 <= x <= 3650
available_events
object[]
obbligatorio

Ogni tipo di evento a cui una destinazione può iscriversi, con un'etichetta visibile.

allowed_return_hosts
string[]
obbligatorio

Hostname (corrispondenza esatta, solo HTTPS) a cui una verifica del wallet Digital ID autonoma può rimandare l'utente con il suo return_url. Anche il tuo dominio white label è sempre consentito. Consulta Registra la tua destinazione di ritorno.

Maximum array length: 20
Maximum string length: 253
endpoints
object[]
obbligatorio

Ogni destinazione webhook dell'applicazione, dalla più vecchia alla più recente, ciascuna con il rispettivo segreto di firma. Qui in sola lettura: gestisci le destinazioni con gli endpoint /v3/webhook/destinations/.

Quando il flusso ospitato e gli SDK nativi richiedono alla persona il consenso biometrico esplicito prima dell'acquisizione del volto. auto (predefinito) lo richiede solo quando si applica un trigger: uno stato dichiarato, l'IP della persona o l'emittente del documento d'identità si trova in Illinois, Texas o Colorado, oppure la persona sembra trovarsi negli Stati Uniti senza uno stato noto. always lo richiede a ogni persona il cui workflow acquisisce un volto. never non mostra mai il passaggio, e raccogli tu stesso il consenso prima del selfie. Ogni modifica viene registrata nel registro di audit. Consulta Consenso biometrico.

Opzioni disponibili:
auto,
always,
never
allowed_domains
string[]

Origini (ad esempio https://app.example.com; http consentito solo per localhost) in cui il flusso di verifica ospitato può essere incorporato e a cui può reindirizzare l'utente con un callback di sessione. Le chiamate server-to-server non sono interessate. Un elenco vuoto indica che non vi sono restrizioni. Didit memorizza ciascuna origine in lettere minuscole e senza porta predefinita. Una voce non valida genera un errore 400 su allowed_domains.

Maximum array length: 50
Maximum string length: 300
Esempio:
Ultima modifica il 7 novembre 2026