Vai al contenuto principale
GET
cURL

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 (il valore uuid restituito dall'endpoint di elenco). Ogni versione di un workflow ha il proprio settings_uuid.

Risposta

Configurazione completa del workflow. Il formato corrisponde alla serializzazione grezza di VerificationSettings (~190 campi: ogni interruttore di funzionalità, soglia, azione di avviso, configurazione dei documenti consentiti, il workflow_graph, politica di nuovo tentativo, callback e prezzi). L'esempio seguente è abbreviato. Nota: features è una stringa unita da " + " (ad es. "OCR + LIVENESS"), i prezzi sono numeri JSON e is_editable è true solo per le versioni draft.

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