Vai al contenuto principale
PATCH
cURL
Usa PATCH per gli aggiornamenti parziali. Per rinominare un workflow, invia solo workflow_label.
Per modificare i controlli del workflow, invia l’intero array features desiderato. Questo sostituisce l’ordine delle funzionalità e la configurazione precedenti.
L’API v3 mantiene i workflow semplici: un percorso lineare e un unico passaggio di stato finale. Non sono accettati rami, nodi di azione e nodi webhook.

Riferimento alla configurazione delle funzionalità

Quando invii features in una PATCH, l’array sostituisce l’ordine delle funzionalità e la configurazione precedenti. Includi di nuovo tutte le configurazioni obbligatorie. L’oggetto config esatto dipende dalla funzionalità. Consulta l’elenco completo dei campi, i valori predefiniti, le impostazioni obbligatorie, gli intervalli di valori e gli esempi in Configurazioni delle funzionalità del workflow. Per OCR, ometti config.documents_allowed, invia null oppure invia {} per consentire ogni tipo di documento supportato. Includilo solo se vuoi limitare il workflow a specifici paesi o tipi di documento. Per QUESTIONNAIRE, config.questionnaire_uuid è obbligatorio.

Aggiornamento delle impostazioni del workflow

Puoi modificare le impostazioni a livello di sessione senza toccare l’elenco delle funzionalità. Invia solo i campi che vuoi cambiare.
Usa come settings_uuid in questo URL lo uuid del workflow restituito dall’endpoint di elenco, creazione o recupero.

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.

Parametri del percorso

settings_uuid
string<uuid>
obbligatorio

UUID per versione del workflow da aggiornare.

Corpo

application/json

Aggiorna i metadati del workflow o sostituisci l'elenco lineare completo delle funzionalità. Whitelist dei campi RIGOROSA: qualsiasi chiave non presente qui viene rifiutata con un 400.

workflow_label
string

Nome visualizzato per il workflow (massimo 50 caratteri).

Maximum string length: 50
is_default
boolean

Imposta questo workflow come predefinito per le nuove sessioni.

status
enum<string>

Controlla il versionamento. Ometti per aggiornare la versione corrente sul posto (le bozze vengono pubblicate automaticamente). published su una versione già pubblicata crea e restituisce una NUOVA versione. draft è valido solo finché la versione è ancora una bozza.

Opzioni disponibili:
draft,
published
features
object[]

Se fornito, questo sostituisce l'intero ordine delle funzionalità e la relativa configurazione.

Minimum array length: 1
is_white_label_enabled
boolean

Abilita la personalizzazione White label per le sessioni create con questo workflow.

is_desktop_allowed
boolean

Consenti l'esecuzione del flusso di verifica sui browser desktop.

max_retry_attempts
integer

Numero massimo di nuovi tentativi consentiti dopo una verifica rifiutata. 0 blocca l'utente dopo il primo rifiuto.

Intervallo richiesto: 0 <= x <= 10
retry_window_days
integer | null

Finestra mobile in giorni utilizzata per contare i nuovi tentativi. null applica un limite complessivo.

Intervallo richiesto: 1 <= x <= 365
face_liveness_max_attempts
integer

Numero massimo di invii per il rilevamento della vitalità per sessione. Questo valore viene copiato anche nei nodi di workflow generati per il rilevamento della vitalità e la stima dell'età, a meno che la configurazione a livello di funzionalità non lo sovrascriva.

Intervallo richiesto: 1 <= x <= 3
face_match_max_attempts
integer

Numero massimo di invii per il confronto facciale per sessione. Questo valore viene copiato anche nei nodi di workflow generati per il confronto facciale, a meno che la configurazione a livello di funzionalità non lo sovrascriva.

Intervallo richiesto: 1 <= x <= 3
session_expiration_time
integer

Secondi prima della scadenza di una sessione non completata. Minimo 1 ora (3600), massimo 4 settimane (2419200).

Intervallo richiesto: 3600 <= x <= 2419200

Risposta

Workflow aggiornato. Il corpo contiene la configurazione COMPLETA della versione risultante (stessa struttura raw VerificationSettings di GET /v3/workflows/{settings_uuid}/). Quando l'aggiornamento ha creato una nuova versione (status: "published" inviato su una riga pubblicata), gli attributi uuid e version restituiti differiscono da quelli modificati: usa lo uuid restituito per le chiamate successive.

I campi sottostanti sono tipizzati; l'oggetto contiene inoltre ogni altra colonna della configurazione del workflow (attivazione delle funzionalità, soglie, azioni di avviso, documenti consentiti, callback) come proprietà aggiuntive. I campi non applicabili al workflow_type sono null.

uuid
string<uuid>

Identificativo per versione (settings_uuid). Ogni versione di un workflow ha il proprio.

workflow_id
string<uuid>

Identificatore stabile condiviso da tutte le versioni del workflow. Le sessioni create con esso utilizzano l'ultima versione pubblicata.

workflow_label
string

Nome visualizzato del workflow.

workflow_type
enum<string> | null

Modello di workflow. null per i workflow a grafo creati senza un modello.

Opzioni disponibili:
kyc,
kyb,
adaptive_age_verification,
biometric_authentication,
address_verification,
questionnaire_verification,
email_verification,
phone_verification,
null
is_default
boolean

Indica se questo è il workflow predefinito dell'applicazione.

is_archived
boolean

I workflow archiviati non possono avviare nuove sessioni.

version
integer

Numero di versione all'interno del workflow.

status
enum<string>

Le versioni in bozza sono modificabili; le versioni pubblicate sono immutabili e utilizzate per le nuove sessioni.

Opzioni disponibili:
draft,
published
published_at
string<date-time> | null

Quando è stata pubblicata questa versione. null per le bozze.

is_simple_workflow
boolean

true quando il workflow non presenta un workflow_graph personalizzato.

is_editable
boolean

true solo per le versioni draft.

workflow_url
string<uri>

URL pubblico che avvia una sessione con questo workflow.

workflow_graph
object | null

Struttura a grafo del workflow (nodi e archi). null per i workflow semplici.

features
string

Funzionalità abilitate unite con " + ", ad esempio "OCR + LIVENESS".

total_price
number | null

Prezzo per sessione; per i workflow a grafo, il percorso più costoso.

min_price
number | null

Prezzo del percorso più economico all'interno del workflow.

max_price
number | null

Prezzo del percorso più costoso all'interno del workflow.

special_add_on_prices
object | null

Prezzi delle funzionalità aggiuntive specifici per l'organizzazione, oppure null se non ne è impostato alcuno.

max_retry_attempts
integer

Nuovi tentativi consentiti dopo una verifica rifiutata.

retry_window_days
integer | null

Giorni durante i quali sono consentiti i nuovi tentativi.

session_expiration_time
integer

Secondi prima della scadenza di una sessione non completata.

questionnaire
object | null

Il questionario associato al workflow, o null.

kyb_role_settings
object[]

Impostazioni di verifica per ruolo per le persone chiave KYB.

created_at
string<date-time>
updated_at
string<date-time>
signature_availability
object

Quali livelli di Firma elettronica possono essere utilizzati per firmare in questo momento. Verificalo prima di impostare signature_level. Restituito nei workflow kyc, kyb e a grafo.

is_bank_verification_enabled
boolean

Indica se un workflow semplice di KYC o KYB esegue la verifica bancaria. Viene eseguita dopo i passaggi di contatto (e la verifica della posizione geografica) e prima della validazione su database, dello screening AML e dell'analisi IP. La verifica bancaria non è ancora disponibile a livello generale: l'attivazione viene rifiutata ovunque non sia abilitata.

bank_verification_config
object

Impostazioni della verifica bancaria di un workflow semplice, con le stesse chiavi accettate da un nodo BANK_VERIFICATION (ad esempio bank_countries e bank_method_order). Le chiavi sconosciute vengono ignorate. Ogni chiave è facoltativa e una chiave assente mantiene il proprio valore predefinito, pertanto {} indica tutti i valori predefiniti. Consulta Impostazioni della verifica bancaria.

Esempio:
is_geolocation_enabled
boolean

Indica se un semplice workflow KYC esegue la verifica della posizione geografica. Viene eseguita dopo i passaggi di contatto e prima della verifica bancaria e della validazione su database. I workflow aziendali (KYB) non possono eseguirla.

geolocation_config
object

Impostazioni di verifica della posizione di un workflow semplice, con le stesse chiavi accettate da un nodo GEOLOCATION (ad esempio is_geolocation_geofencing_enabled e geolocation_max_attempts). Le chiavi sconosciute vengono ignorate. Ogni chiave è facoltativa e una chiave assente mantiene il valore predefinito, quindi {} indica tutti i valori predefiniti.

Esempio:
Ultima modifica il 7 novembre 2026