Vai al contenuto principale
POST
curl

Panoramica

Attiva o disattiva il monitoraggio AML continuo per le entità utente selezionate, esattamente come l’azione Monitoraggio AML continuo nella Business Console. La Console e questo endpoint eseguono la stessa operazione sottostante, quindi regole, fatturazione ed esiti sono identici. Invia prima estimate_only: true per vedere quanti utenti sono selezionati, quanti richiedono un nuovo Screening AML, il costo una tantum dello screening e il costo annuale del monitoraggio. Una simulazione non scrive nulla.

Quando usarlo

  • Onboarding programmatico: attiva il monitoraggio per gli utenti importati o creati tramite API senza ripetere lo screening manualmente.
  • Offboarding: interrompi il monitoraggio, e il relativo rinnovo annuale, per gli utenti che hanno lasciato la tua piattaforma.
  • Controllo dei costi: visualizza in anticipo l’impatto esatto sui costi di una selezione prima di confermarla.

Come viene elaborata una selezione

  • Un solo screening monitorato per utente. Un utente che ha effettuato più verifiche viene monitorato e fatturato una sola volta. La disattivazione spegne il monitoraggio su tutti gli screening di quell’utente.
  • Gli utenti senza Screening AML vengono sottoposti prima a screening. Didit crea per loro una nuova verifica AML (visibile nella scheda Verifiche dell’utente), fatturata come uno Screening AML standard, e attiva su di essa il monitoraggio. Sono necessari nome completo, data di nascita e paese; un utente a cui manca uno di questi dati viene segnalato come skipped_no_identity_data invece di essere ignorato in silenzio.
  • Gli utenti bloccati vengono saltati (skipped_blocked). Le applicazioni sandbox non creano mai screening (skipped_sandbox).
  • Il saldo viene verificato in anticipo. L’attivazione viene rifiutata con 403 quando il saldo non copre la stima, e la risposta contiene la stima così sai quanto ricaricare.
  • Rinnovo annuale. A un utente appena monitorato viene addebitato il prezzo annuale del monitoraggio alla sua prossima data di rinnovo, la stessa data che la Console mostra nella colonna Monitoraggio continuo. La disattivazione interrompe il rinnovo; non rimborsa un periodo già fatturato.

Selezione e dimensione del batch

Seleziona gli utenti con vendor_data_list, didit_internal_id_list, o con entrambi; le due liste sono combinate con OR. Una richiesta accetta al massimo 1000 identificativi in totale tra le due liste. Gli identificativi che non corrispondono a nessun utente della tua applicazione vengono restituiti in unmatched, esattamente come inviati, e non fanno mai fallire la richiesta: una selezione senza corrispondenze si completa come job vuoto (total: 0) con tutti gli identificativi elencati, secondo la stessa convenzione degli endpoint di eliminazione in batch.

In linea o in background

Le selezioni di 20 utenti o meno vengono elaborate in linea e la chiamata restituisce 200 con il job completato. Le selezioni più grandi restituiscono 202 con un job PENDING; interroga Get AML Monitoring Job finché status non diventa COMPLETED o FAILED. In entrambi i casi il job contiene una voce results per ogni utente con il relativo outcome.

Webhook

L’attivazione o la disattivazione del monitoraggio non genera un webhook proprio. Una volta attivo il monitoraggio, i nuovi screening continuano a generare gli eventi status.updated e data.updated descritti in Continuous AML Monitoring.

Autorizzazioni

Qualsiasi chiave API attiva dell’applicazione può chiamare questo endpoint. Le chiavi API di Didit sono limitate all’applicazione, non al ruolo: i ruoli e le autorizzazioni della Console determinano cosa può fare una persona nella Console e non vengono valutati per il traffico della Management API.

Correlati

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

Seleziona gli utenti con vendor_data_list, didit_internal_id_list o entrambi (i due elenchi vengono combinati con OR). Al massimo 1000 identificatori per richiesta considerando entrambi gli elenchi.

is_enabled
boolean
obbligatorio

true per abilitare il monitoraggio, false per disabilitarlo.

estimate_only
boolean
predefinito:false

Se true, restituisce la stima dei costi e non esegue scritture: nessuno screening, nessuna fatturazione, nessun job.

vendor_data_list
string[]

I tuoi identificatori degli utenti da attivare/disattivare, confrontati esattamente come inviati.

didit_internal_id_list
string<uuid>[]

ID interni Didit degli utenti da attivare o disattivare: il didit_internal_id restituito dagli endpoint di creazione, recupero ed elenco.

Risposta

La stima (quando estimate_only è true) o il processo completato per una selezione elaborata in linea.

Anteprima dei costi. Restituita direttamente quando estimate_only è true (non viene scritto nulla).

users_total
integer
obbligatorio

Profili corrispondenti alla selezione.

already_enabled
integer
obbligatorio

Profili già monitorati (nessuna operazione da eseguire durante l'abilitazione; sono quelli che vengono disattivati quando si disabilita il monitoraggio).

with_existing_aml
integer
obbligatorio

Profili il cui Screening AML esistente verrà impostato come monitorato (nessun nuovo screening).

needing_screening
integer
obbligatorio

Profili senza alcuno Screening AML che verranno prima sottoposti a screening (fatturati come normale Screening AML).

skipped_no_identity_data
integer
obbligatorio

Profili di cui non è possibile effettuare lo screening a causa della mancanza dei dati di identità.

skipped_blocked
integer
obbligatorio

Utenti bloccati che verranno saltati (sempre 0 per le aziende).

estimated_screening_cost_usd
number
obbligatorio

Costo una tantum dei nuovi screening.

Esempio:

0.2

estimated_annual_monitoring_cost_usd
number
obbligatorio

Costo annuale di monitoraggio dei profili che passeranno a essere monitorati.

Esempio:

0.07

balance_sufficient
boolean
obbligatorio

Indica se il saldo dell'organizzazione copre lo screening e il primo anno di monitoraggio.

unmatched
string[]
obbligatorio

Identificatori della richiesta che non hanno trovato corrispondenza con alcun profilo in questa applicazione, esattamente come inviati.

Ultima modifica il 7 novembre 2026