Vai al contenuto principale
POST
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.

Intestazioni

Idempotency-Key
string

Chiave opzionale di sicurezza per i nuovi tentativi, fino a 255 caratteri. Riutilizzare la stessa chiave con lo stesso corpo della richiesta restituisce la risposta originale senza eseguire né fatturare un secondo screening. Riutilizzare la chiave con un corpo diverso restituisce 409.

Maximum string length: 255

Corpo

application/json
full_name
string
obbligatorio

Nome completo della persona o azienda da sottoporre a screening. Minimo 2 caratteri (limite minimo imposto dal fornitore di screening). Un nome più corto o vuoto restituisce 400 su questo campo prima che venga eseguito qualsiasi screening, quindi non viene addebitato alcun costo.

Minimum string length: 2
Esempio:

"Antonio Ejemplo Modelo"

entity_type
enum<string>
predefinito:person

Tipo di entità da sottoporre a screening. Il valore predefinito è person.

Opzioni disponibili:
person,
company
date_of_birth
string<date>

Data di nascita (persone) o data di costituzione (aziende), YYYY-MM-DD. Migliora la precisione della corrispondenza tramite il peso della data di nascita.

Esempio:

"1972-02-29"

nationality
string

Codice paese ISO 3166-1 alpha-2 (ad es. ES). I codici non validi restituiscono 400. Migliora la precisione della corrispondenza tramite il peso del paese.

Esempio:

"ES"

document_number
string

Numero del documento d'identità. Non ponderato — funge da chiave di riferimento: una corrispondenza esatta sovrascrive il match_score del riscontro portandolo a 100, mentre una netta mancata corrispondenza lo penalizza. Inviato al fornitore di screening come filtro di ricerca solo quando è di 2-50 caratteri; un valore al di fuori di questo intervallo viene accettato e memorizzato, e lo screening viene comunque eseguito e fatturato, semplicemente senza restrizione per numero di documento.

aml_score_approve_threshold
number
predefinito:80

Soglia del punteggio di rischio pari o inferiore alla quale il risultato è Approved. Deve essere ≤ aml_score_review_threshold (altrimenti 400).

Intervallo richiesto: 0 <= x <= 100
aml_score_review_threshold
number
predefinito:100

Soglia del punteggio di rischio al di sopra della quale il risultato è Declined. I punteggi compresi tra le due soglie generano In Review.

Intervallo richiesto: 0 <= x <= 100
aml_name_weight
integer
predefinito:60

Peso della somiglianza del nome nel punteggio di corrispondenza per singola occorrenza. I tre pesi devono dare come somma esattamente 100 (altrimenti 400).

Intervallo richiesto: 0 <= x <= 100
aml_dob_weight
integer
predefinito:25

Peso della data di nascita nel punteggio di corrispondenza per singola occorrenza.

Intervallo richiesto: 0 <= x <= 100
aml_country_weight
integer
predefinito:15

Peso del paese/nazionalità nel punteggio di corrispondenza per singola occorrenza.

Intervallo richiesto: 0 <= x <= 100
aml_match_score_threshold
integer
predefinito:93

Soglia per hit: gli hit con match_score inferiore a questo valore sono False Positive (esclusi dalla valutazione del rischio); quelli pari o superiori sono possibili corrispondenze Unreviewed.

Intervallo richiesto: 0 <= x <= 100
include_adverse_media
boolean
predefinito:false

Cerca anche notizie negative sui media. Aggiunge fino a ~30 s di latenza durante la raccolta dei risultati; utilizza un timeout del client ≥60 s.

include_ongoing_monitoring
boolean
predefinito:false

Continua a eseguire lo screening periodico di questo profilo e invia le modifiche tramite webhook. Richiede save_api_request=true (altrimenti 400).

save_api_request
boolean
predefinito:true

Salva lo screening come sessione (visibilità nella console, endpoint della decisione, webhook, revisione dei riscontri). Imposta su false per un controllo senza stato.

vendor_data
string

Il tuo identificatore per l'utente sottoposto a screening; restituito nella risposta e memorizzato con la sessione.

metadata
object | null

JSON a struttura libera memorizzato con la richiesta e restituito nella risposta.

sandbox_scenario
string

Slug dello scenario solo per sandbox. Accettato solo quando la chiave API appartiene a un'applicazione in modalità sandbox; rifiutato nelle applicazioni di produzione. Uno screening autonomo non ha una sessione da preparare, quindi lo slug va inserito direttamente nella richiesta di screening: decline_aml_hit restituisce una corrispondenza con struttura identica a quella di produzione e conclude lo screening come Declined, review_aml_possible_match lo conclude come In Review, mentre uno scenario che non imposta alcun esito AML lascia lo screening pulito. Consulta il catalogo degli scenari su GET /v1/sandbox/scenarios/ o Sandbox & Test Data.

Esempio:

"decline_aml_hit"

Risposta

Screening completato. aml.status riflette le tue soglie; ogni hit pari o superiore alla soglia minima interna di inclusione è elencato in aml.hits con il relativo match_score di identità, risk_score dell'entità e uno score_breakdown che spiega la corrispondenza.

request_id
string<uuid>

ID della sessione salvata quando save_api_request=true (utilizzabile con GET /v3/session/{sessionId}/decision/); altrimenti un UUID di correlazione temporaneo.

aml
object
vendor_data
string | null

Eco del vendor_data inviato.

metadata
object | null

Eco del metadata inviato.

created_at
string<date-time>
Ultima modifica il 7 novembre 2026