Vai al contenuto principale
POST
curl
Aggiunge una voce a una lista. Il valore viene validato in base al tipo di voce della lista:
  • email: un indirizzo email valido
  • telefono: un numero di telefono internazionale valido, memorizzato in formato E.164 (ad esempio +14155552671)
  • ip_address: un indirizzo IP valido o un intervallo CIDR (ad esempio 192.168.1.1 o 10.0.0.0/8)
  • device_fingerprint: almeno 8 caratteri tra lettere, cifre, -, _, : e .. Una blocklist rifiuta un fingerprint che più dispositivi distinti hanno segnalato, perché bloccarlo bloccherebbe persone non collegate
  • paese: un codice paese ISO 3166-1 alpha-3 valido (ad esempio USA, GBR, ESP). I codici alpha-2 (ad esempio US) sono accettati e convertiti automaticamente in alpha-3
  • utente, azienda: il vendor_data dell’utente o dell’azienda
  • volto, documento, wallet_address, bank_account, chiave: qualsiasi stringa non vuota
Tutti i valori delle voci sono senza distinzione tra maiuscole e minuscole. I valori inviati vengono normalizzati alla memorizzazione (numeri di telefono in E.164, codici paese in maiuscolo, tutto il resto in minuscolo) e confrontati senza distinzione tra maiuscole e minuscole durante la verifica. Ad esempio, bloccando User@Example.COM verrà intercettato anche user@example.com. Una lista contiene ogni valore una sola volta: l’aggiunta di un valore già presente nella lista restituisce 400.
Per un volto, usa Carica volto quando hai solo un’immagine, oppure invia un reference_session_id per prendere il volto di una sessione esistente. Una voce di tipo volto richiede un volto memorizzato con cui confrontarsi, che un value digitato non fornisce.

Aggiunta da una sessione

Quando fornisci un reference_session_id, Didit:
  1. Cerca la sessione (deve appartenere alla stessa applicazione)
  2. Legge il valore dal record più recente della sessione relativo al tipo di voce della lista:
    • volto: il volto del selfie di prova di vitalità; value è l’UUID del volto
    • documento: il numero del documento; il nome completo, lo stato di emissione, il tipo di documento, la regione e il numero del documento vengono memorizzati in metadata, e display_label è impostato per default con il nome del titolare e il numero del documento
    • telefono: il numero di telefono
    • email: l’indirizzo email
    • ip_address: l’indirizzo IP della sessione
    • device_fingerprint: un fingerprint che identifica un dispositivo, con preferenza per un dispositivo che ha completato un passaggio di verifica. In una blocklist, Didit rifiuta una sessione che ha solo un fingerprint di classe dispositivo, oppure uno completato su più di un dispositivo: in tal caso invia il fingerprint esatto come value
  3. Collega la voce alla sessione (reference_session_id) e al record (reference_object_uuid) per la tracciabilità
Nelle blocklist di sistema per volto, documento, telefono ed email, il record viene anche contrassegnato come in blocklist, quindi le nuove sessioni che corrispondono vengono rifiutate. Per qualsiasi altro tipo di voce, invia anche value. Restituisce 400 se la sessione non viene trovata o non contiene dati per il tipo di voce richiesto.

Volti dal selfie della cattura del documento

Mentre l’utente fotografa il documento, la fotocamera frontale può scattare un selfie (le immagini front_image_camera_front e back_image_camera_front del report di verifica dell’identità). Quel volto può essere aggiunto anche alla blocklist dei volti, oltre al volto della prova di vitalità: passa face_image_source con l’immagine che desideri.
  • La voce viene creata solo nella blocklist dei volti di sistema, e value deve essere lasciato vuoto: Didit prende il volto dal selfie della sessione.
  • Il selfie deve contenere un solo volto ben visibile. In caso contrario la richiesta restituisce 400 e non viene aggiunto nulla.
  • Ogni selfie può essere aggiunto una sola volta. metadata.face_image_source e metadata.reference_node_id della voce indicano da quale selfie proviene.
  • In un workflow con più di un passaggio di verifica dell’identità, reference_node_id sceglie il passaggio di cui usare il selfie. Per default Didit usa la verifica dell’identità più recente che ha quel selfie.
  • Da quel momento il volto viene controllato come qualsiasi altro volto in blocklist: contro il selfie di prova di vitalità di ogni nuova sessione e contro ogni nuovo selfie della cattura del documento (vedi FRONT_CAMERA_FACE_IN_BLOCKLIST).
  • Eliminare la voce rimuove il volto dalla blocklist e il volto non verrà più confrontato con le nuove sessioni.

Sessioni con più record dello stesso tipo

Una sessione può contenere più record di un tipo, ad esempio due numeri di telefono da un workflow in più passaggi. Didit legge sempre quello più recente. Se invii value insieme a reference_session_id, la voce memorizza il tuo value ma resta collegata a quel record più recente, e in una blocklist di sistema è quel record a essere contrassegnato. Per inserire in lista un valore da un record precedente, aggiungilo solo tramite value, senza reference_session_id:

Riferimenti a transazioni, utenti e aziende

Quando aggiungi alla blocklist dati di una transazione o di un utente o di un’azienda del fornitore, passa l’UUID dell’entità come reference_object_uuid e indica il tipo di origine in metadata:
Questo ti permette di risalire dalla voce della blocklist alla transazione, all’utente o all’azienda originale nella console. Didit memorizza le chiavi di metadata che invii, tranne reference_image_url e front_image_url, che imposta solo Didit. Per una voce letta da una sessione, Didit aggiunge le proprie chiavi alle tue, e le sue chiavi prevalgono. Nelle blocklist di sistema Utenti e Aziende, Didit imposta anche gli utenti o le aziende corrispondenti su BLOCKED: quelli il cui vendor_data è uguale a value, oppure il cui didit_internal_id è uguale a reference_object_uuid. Vedi blocklist degli utenti e blocklist delle aziende.

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

list_uuid
string<uuid>
obbligatorio

UUID della lista a cui aggiungere l'elemento. Per un volto disponibile solo come immagine, usa invece Upload a face to a list.

Corpo

application/json

Invia value, reference_session_id o entrambi. I campi applicabili dipendono dall'entry_type della lista.

value
string

Il valore da inserire nell'elenco, validato rispetto all'entry_type della lista: email un indirizzo email valido; phone un numero internazionale valido, memorizzato in formato E.164; ip_address un indirizzo IP o un intervallo CIDR (ad esempio 10.0.0.0/8); device_fingerprint almeno 8 caratteri tra lettere, cifre, -, _, : e . (una blocklist rifiuta un'impronta segnalata da diversi dispositivi distinti); country un codice ISO 3166-1 alpha-2 o alpha-3, memorizzato come alpha-3; user e business il vendor_data; qualsiasi altro tipo una stringa non vuota. Memorizzato in minuscolo tranne i numeri di telefono e i codici paese, e una lista contiene ciascun valore una sola volta (senza distinzione tra maiuscole e minuscole). Obbligatorio a meno che non venga inviato reference_session_id; deve essere lasciato vuoto con un face_image_source di acquisizione del documento.

reference_session_id
string<uuid>

Una sessione di verifica di una persona o di un'azienda della tua applicazione da cui acquisire il valore. Didit legge il record più recente della sessione corrispondente al tipo di voce della lista (face, document, phone, email, ip_address o device_fingerprint), collega la voce alla sessione e a quel record e compila display_label e metadata per i documenti. Per una blocklist di tipo device_fingerprint, una sessione che dispone solo di un'impronta di classe dispositivo, o che è stata completata su più dispositivi, viene rifiutata: invia l'impronta esatta come value. Per altri tipi di voce, o quando la sessione non contiene tale record, invia anche value; in tal caso, il tuo value viene memorizzato e la voce rimane comunque collegata alla sessione.

reference_object_uuid
string<uuid>

UUID del record rappresentato dalla voce quando non proviene da una sessione: un UUID di transazione oppure il didit_internal_id di un utente o di un'azienda. Abbinalo a metadata.reference_type. Sostituito dal record della sessione quando reference_session_id ne fornisce uno.

face_image_source
enum<string>
predefinito:liveness

Elenchi di volti con reference_session_id: da quale delle immagini della sessione viene estratto il volto. liveness (impostazione predefinita) è il selfie di rilevamento della vitalità. front_image_camera_front e back_image_camera_front sono i selfie scattati dalla fotocamera anteriore mentre l'utente fotografava il fronte o il retro del proprio documento: accettati solo sulla blocklist di volti di sistema, con reference_session_id e un value vuoto. Ciascun selfie può essere aggiunto una sola volta e deve mostrare un unico volto ben visibile.

Opzioni disponibili:
liveness,
front_image_camera_front,
back_image_camera_front
reference_node_id
string | null

Con un face_image_source di acquisizione del documento: il nodo di verifica dell'identità di cui usare il selfie, per i workflow che ne contengono più di uno. Il valore predefinito è la verifica dell'identità più recente contenente tale immagine. Rifiutato con liveness.

Maximum string length: 100
display_label
string

Etichetta di facile lettura. Se vuota, Didit ne ricava una dalla sessione ove possibile (ad esempio il nome del titolare e il numero del documento).

Maximum string length: 512
comment
string

Nota in formato testo libero, ad esempio il motivo dell'inclusione nella lista.

metadata
object

JSON a struttura libera memorizzato con la voce e restituito così come memorizzato. Usa reference_type e reference_id affinché la console rimandi alla fonte. reference_image_url e front_image_url sono impostati esclusivamente da Didit e vengono rimossi se li invii. Per una voce letta da una sessione, le chiavi di Didit vengono unite alle tue.

Risposta

La voce è stata creata.

Un singolo valore in una lista.

uuid
string<uuid>
obbligatorio

Identificatore della voce. Utilizzalo come entry_uuid in Elimina una voce dell'elenco.

value
string
obbligatorio

Il valore inserito in lista: un numero di telefono in formato E.164, un indirizzo email, un numero di documento, un indirizzo IP o un intervallo CIDR, un'impronta digitale del dispositivo, un indirizzo del wallet, un conto bancario, un codice paese ISO 3166-1 alpha-3, un vendor_data, qualsiasi stringa su una lista key, oppure l'UUID del volto memorizzato su una lista di volti. I valori inviati vengono memorizzati in minuscolo, ad eccezione dei numeri di telefono e dei codici paese. La corrispondenza non fa distinzione tra maiuscole e minuscole.

display_label
string | null
obbligatorio

Etichetta di facile lettura. Didit la compila per le voci estratte da una sessione (ad esempio il nome del titolare e il numero del documento) quando non ne invii nessuna.

Maximum string length: 512
comment
string
obbligatorio

Nota in formato testo libero. Stringa vuota se non impostata.

added_by
string | null
obbligatorio

Chi ha aggiunto la voce: api (una chiave API), l'indirizzo email di un utente della console o console, system o migration (voci create da Didit), oppure rule (un'azione di una regola di transazione o monitoraggio).

reference_session_id
string<uuid> | null
obbligatorio

Sessione di verifica da cui è stata estratta la voce. null quando la voce è stata aggiunta per valore.

reference_session_number
integer | null
obbligatorio

Numero della sessione con ambito limitato all'applicazione, come mostrato nella console.

reference_session_type
enum<string> | null
obbligatorio

kyc per una sessione di verifica di una persona fisica, kyb per una sessione di verifica aziendale, null quando non è presente alcuna sessione.

Opzioni disponibili:
kyc,
kyb,
null
reference_object_uuid
string<uuid> | null
obbligatorio

Il record rappresentato dalla voce: il record del volto, del documento, del telefono o dell'email letto da una sessione, il volto creato tramite Upload a face to a list, o l'UUID inviato (ad esempio l'UUID di una transazione o il didit_internal_id di un utente).

metadata
object | null
obbligatorio

Contesto aggiuntivo. Contiene le chiavi impostate da Didit (elencate qui) unite a qualsiasi metadata inviato durante la creazione della voce, restituite così come memorizzate. null se non è presente alcuno.

created_at
string<date-time>
obbligatorio

Data e ora di aggiunta della voce.

Ultima modifica il 7 novembre 2026