Vai al contenuto principale
PATCH
curl
rotate_secret_key ruota solo il segreto a livello di applicazione, che firma le consegne verso il webhook_url legacy. Ogni destinazione webhook firma con il proprio secret_shared_key, che questa chiamata non modifica.
I campi di conservazione seguono la stessa policy che imposti in Business Console → App Settings → Data retention. Leggi Conservazione dei dati prima di modificarli, in particolare la conservazione del modello biometrico. allowed_return_hosts è descritto in Registra la tua destinazione di ritorno. biometric_consent_mode (auto, always o never) stabilisce quando il flusso di verifica chiede il consenso biometrico esplicito prima di acquisire un’immagine del volto. Vedi Consenso biometrico. Per leggere prima i valori attuali, chiama Leggi la configurazione webhook.

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.

Corpo

application/json

Invia solo i campi da modificare. Le destinazioni non vengono gestite qui.

webhook_url
string<uri> | null

URL del webhook legacy a livello di applicazione. Didit lo usa solo quando l'applicazione non ha alcuna destinazione abilitata, e solo per status.updated e data.updated. Non crea una destinazione, e la successiva creazione, aggiornamento o eliminazione di una destinazione lo sostituisce. Per ricevere webhook, crea invece una destinazione con POST /v3/webhook/destinations/.

Maximum string length: 2000
webhook_version
enum<string>

Versione del payload del webhook_url legacy.

Opzioni disponibili:
v1,
v2,
v3
rotate_secret_key
boolean
predefinito:false

true sostituisce immediatamente la secret_shared_key a livello di applicazione con un nuovo valore casuale; il nuovo valore è presente nella risposta. I segreti di destinazione non vengono modificati. Ogni chiamata con true genera un nuovo segreto, pertanto non è idempotente.

capture_method
enum<string>

Impostazione legacy dell'applicazione. Il flusso di verifica non la legge.

Opzioni disponibili:
MOBILE,
MOBILE_AND_DESKTOP
data_retention_months
integer | null

Intervallo di eliminazione automatica in mesi (un mese equivale a 30 giorni), oppure null per nessuna eliminazione automatica. Una modifica si applica anche alle sessioni esistenti: ogni sessione di verifica degli utenti più vecchia del nuovo intervallo viene eliminata automaticamente, e tale eliminazione è irreversibile.

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

Cosa succede all'embedding facciale di una sessione quando la sessione viene eliminata. retain_until_user_deleted richiede face_retention_days nella stessa richiesta o già impostato. Una modifica si applica alle eliminazioni di sessioni da quel momento in poi; non crea né elimina alcun modello biometrico esistente.

Opzioni disponibili:
delete_with_session,
retain_until_user_deleted
face_retention_days
integer | null

Periodo di conservazione, in giorni, dei modelli biometrici secondo retain_until_user_deleted.

Intervallo richiesto: 1 <= x <= 3650

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_return_hosts
string[]

Sostituisce l'intero elenco di host di ritorno del wallet Digital ID. Solo hostname semplici, come ad esempio shop.example.com: nessuno schema, porta, percorso o carattere jolly. I valori vengono convertiti in minuscolo e i duplicati vengono rimossi. Invia [] per cancellare l'elenco.

Maximum array length: 20
Maximum string length: 253
allowed_domains
string[]

Sostituisce l'intero elenco delle origini consentite. Origini (ad esempio https://app.example.com; http solo per localhost) in cui il flusso di verifica ospitato può essere incorporato e a cui può reindirizzare l'utente con una callback di sessione. Le chiamate server-to-server non sono interessate. Un elenco vuoto indica nessuna restrizione. Didit memorizza ciascuna origine in lettere minuscole senza una porta predefinita. Una voce non valida genera un errore 400 su allowed_domains. Invia [] per rimuovere la restrizione.

Maximum array length: 50
Maximum string length: 300
Esempio:

Risposta

La configurazione completa dopo l'aggiornamento, con la stessa struttura di GET /v3/webhook/. Se hai ruotato il segreto, memorizza la nuova secret_shared_key prima di eliminare la risposta.

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