curl -X POST 'https://verification.didit.me/v3/users/aml-monitoring/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"is_enabled": true, "vendor_data_list": ["user-123", "user-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.set_aml_monitoring(
is_enabled=True,
estimate_only=True,
vendor_data_list=["user-123", "user-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.setAmlMonitoring({
is_enabled: true,
estimate_only: true,
vendor_data_list: ["user-123", "user-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.SetAMLMonitoring(ctx, didit.UsersSetAMLMonitoringParams{
IsEnabled: true,
EstimateOnly: didit.Bool(true),
VendorDataList: didit.Some([]string{"user-123", "user-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.UsersSetAmlMonitoringParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().setAmlMonitoring(UsersSetAmlMonitoringParams.builder()
.isEnabled(true)
.estimateOnly(true)
.vendorDataList(List.of("user-123", "user-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->setAmlMonitoring([
'is_enabled' => true,
'estimate_only' => true,
'vendor_data_list' => ['user-123', 'user-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.set_aml_monitoring(
is_enabled: true,
estimate_only: true,
vendor_data_list: ["user-123", "user-456"]
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.SetAmlMonitoringAsync(new UsersSetAmlMonitoringParams
{
IsEnabled = true,
EstimateOnly = true,
VendorDataList = new string[] { "user-123", "user-456" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true,
"unmatched": [
"<string>"
]
}{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"is_enabled": true,
"target_type": "user",
"total": 123,
"processed": 123,
"outcomes": {
"enabled": 123,
"screened_and_enabled": 123,
"already_enabled": 123,
"disabled": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"skipped_sandbox": 123,
"failed_provider": 123,
"failed_insufficient_balance": 123
},
"results": [
{
"didit_internal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_data": "<string>",
"outcome": "enabled"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
},
"unmatched": [
"<string>"
]
}{
"error": "<string>",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
}
}API per activar i desactivar el monitoratge AML
Activa o desactiva el monitoratge AML continu de molts usuaris en una crida a l’API de Didit, amb estimació de cost i resultat per usuari.
curl -X POST 'https://verification.didit.me/v3/users/aml-monitoring/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"is_enabled": true, "vendor_data_list": ["user-123", "user-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.users.set_aml_monitoring(
is_enabled=True,
estimate_only=True,
vendor_data_list=["user-123", "user-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.users.setAmlMonitoring({
is_enabled: true,
estimate_only: true,
vendor_data_list: ["user-123", "user-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Users.SetAMLMonitoring(ctx, didit.UsersSetAMLMonitoringParams{
IsEnabled: true,
EstimateOnly: didit.Bool(true),
VendorDataList: didit.Some([]string{"user-123", "user-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.UsersSetAmlMonitoringParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.users().setAmlMonitoring(UsersSetAmlMonitoringParams.builder()
.isEnabled(true)
.estimateOnly(true)
.vendorDataList(List.of("user-123", "user-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->users->setAmlMonitoring([
'is_enabled' => true,
'estimate_only' => true,
'vendor_data_list' => ['user-123', 'user-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.users.set_aml_monitoring(
is_enabled: true,
estimate_only: true,
vendor_data_list: ["user-123", "user-456"]
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Users.SetAmlMonitoringAsync(new UsersSetAmlMonitoringParams
{
IsEnabled = true,
EstimateOnly = true,
VendorDataList = new string[] { "user-123", "user-456" },
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true,
"unmatched": [
"<string>"
]
}{
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "PENDING",
"is_enabled": true,
"target_type": "user",
"total": 123,
"processed": 123,
"outcomes": {
"enabled": 123,
"screened_and_enabled": 123,
"already_enabled": 123,
"disabled": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"skipped_sandbox": 123,
"failed_provider": 123,
"failed_insufficient_balance": 123
},
"results": [
{
"didit_internal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendor_data": "<string>",
"outcome": "enabled"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
},
"unmatched": [
"<string>"
]
}{
"error": "<string>",
"estimate": {
"users_total": 123,
"already_enabled": 123,
"with_existing_aml": 123,
"needing_screening": 123,
"skipped_no_identity_data": 123,
"skipped_blocked": 123,
"estimated_screening_cost_usd": 0.2,
"estimated_annual_monitoring_cost_usd": 0.07,
"balance_sufficient": true
}
}Visió general
Activa o desactiva el monitoratge AML continu per a les entitats d’usuari seleccionades, exactament igual que l’acció Monitoratge AML continu de la Business Console. La consola i aquest endpoint executen la mateixa operació subjacent, de manera que les regles, la facturació i els resultats són idèntics. Envia primerestimate_only: true per veure quants usuaris estan seleccionats, quants necessiten un nou cribratge AML, el cost únic del cribratge i el cost anual del monitoratge. Una execució de prova no escriu res.
Quan utilitzar-lo
- Alta programàtica: activa el monitoratge per als usuaris que has importat o creat a través de l’API sense tornar a fer el cribratge manualment.
- Baixa: atura el monitoratge, i la seva renovació anual, per als usuaris que han deixat la plataforma.
- Control de costos: previsualitza l’impacte exacte en el cost d’una selecció abans de confirmar-la.
Com es processa una selecció
- Un cribratge monitoritzat per usuari. Un usuari que s’ha verificat diverses vegades es monitoritza i es factura una sola vegada. La desactivació apaga el monitoratge en tots els cribratges d’aquest usuari.
- Als usuaris sense cribratge AML se’ls fa primer el cribratge. Didit crea una nova verificació AML per a ells (visible a la pestanya Verificacions de l’usuari), facturada com un cribratge AML habitual, i hi activa el monitoratge. Això requereix el nom complet, la data de naixement i el país de l’usuari; un usuari al qual li falti qualsevol d’aquestes dades s’indica com a
skipped_no_identity_datai no s’omet silenciosament. - Els usuaris bloquejats s’ometen (
skipped_blocked). Les aplicacions de sandbox no creen mai cribratges (skipped_sandbox). - El saldo es comprova per endavant. Activar el monitoratge es rebutja amb
403quan el teu saldo no cobreix l’estimació, i la resposta inclou l’estimació perquè sàpigues quant has de recarregar. - Renovació anual. Un usuari monitoritzat de nou es factura amb el preu anual del monitoratge a la seva propera data de renovació, la mateixa que mostra la Console a la columna Monitoratge continu. La desactivació atura la renovació; no reembossa cap període ja facturat.
Selecció i mida del lot
Selecciona usuaris ambvendor_data_list, didit_internal_id_list, o amb totes dues. Les dues llistes es combinen amb OR. Una sol·licitud accepta com a màxim 1000 identificadors entre totes dues llistes. Els identificadors que no coincideixin amb cap usuari de la teva aplicació es retornen a unmatched, tal com s’han enviat, i mai no fan fallar la sol·licitud: una selecció que no coincideix amb res es completa com a tasca buida (total: 0) amb tots els identificadors enumerats, seguint la mateixa convenció que els endpoints d’eliminació per lots.
En línia o en segon pla
Les seleccions de 20 usuaris o menys es processen en línia i la crida retorna200 amb la tasca finalitzada. Les seleccions més grans retornen 202 amb una tasca PENDING; consulta Obtenir la tasca de monitoratge AML fins que status sigui COMPLETED o FAILED. En tots dos casos, la tasca inclou una entrada results per usuari amb el seu outcome.
outcome | Significat |
|---|---|
enabled | Monitoratge activat en un cribratge AML existent. |
screened_and_enabled | S’ha creat un nou cribratge AML (facturat) i s’hi ha activat el monitoratge. |
already_enabled | El monitoratge ja estava actiu; no s’ha canviat res i no s’ha facturat res. |
disabled | Monitoratge desactivat en tots els cribratges de l’usuari. |
skipped_no_identity_data | A l’usuari li falta el nom complet, la data de naixement o el país necessaris per fer el cribratge. |
skipped_blocked | L’usuari està bloquejat. |
skipped_sandbox | Aplicació de sandbox; no es crea cap cribratge. |
failed_provider | No s’ha pogut completar el cribratge. Torna-ho a intentar més tard. |
failed_insufficient_balance | El saldo s’ha esgotat mentre la tasca s’executava. |
Webhooks
Activar o desactivar el monitoratge no emet cap webhook propi. Un cop el monitoratge està actiu, els recribratges continuen enviant els esdeveniments habitualsstatus.updated i data.updated descrits a Monitoratge AML continu.
Permisos
Qualsevol clau d’API activa de l’aplicació pot cridar aquest endpoint. Les claus d’API de Didit tenen un abast definit per l’aplicació, no pel rol: els rols i permisos de la Console determinen què pot fer una persona a la Console i no s’avaluen per al trànsit de la Management API.Relacionat
- Obtenir la tasca de monitoratge AML
- Activar o desactivar el monitoratge AML per a empreses
- Monitoratge AML continu
- API de cribratge AML
- Llistar usuaris
Autoritzacions
La clau d'API de la teva aplicació, des de Developers -> API keys a la Business Console. La clau primària té accés complet. Una clau amb nom pot tenir l'abast limitat: cap, lectura o escriptura per recurs, limitada a determinats fluxos de treball o a sessions aprovades, a una llista d'adreces IP i a una data de caducitat. 401 significa que la clau és incorrecta, revocada o caducada; 403 significa que no s'ha enviat cap clau, que la clau no té accés a aquest recurs o acció, o que la sol·licitud prové d'una adreça fora de la seva llista d'IP; 404 en una ruta de sessió significa que la sessió està fora dels fluxos de treball o estats de la clau. Una clau sense accés a fitxers multimèdia rep els URL d'imatge, vídeo i PDF com a null, i una clau sense permís d'escriptura de sessions rep els enllaços de sessió i els tokens com a null. Consulta https://docs.didit.me/console/api-keys.
Cos
Selecciona usuaris amb vendor_data_list, didit_internal_id_list, o amb totes dues (les dues llistes s'avaluen amb un OR lògic). Com a màxim 1000 identificadors per sol·licitud entre ambdues llistes.
true per activar el monitoratge, false per desactivar-lo.
Quan és cert, retorna l'estimació del cost i no realitza cap escriptura: sense cribratge, sense facturació i sense tasca.
Els teus propis identificadors dels usuaris a commutar, coincidits exactament com es van enviar.
ID interns de Didit dels usuaris per activar o desactivar: el didit_internal_id retornat pels endpoints de creació, obtenció i llistat.
Resposta
L'estimació (quan estimate_only és cert) o la tasca completada per a una selecció processada en línia.
- Option 1
- Option 2
Vista prèvia del cost. Es retorna directament quan estimate_only és true (no s'escriu res).
Perfils que coincideixen amb la selecció.
Perfils que ja estan monitorats (res a fer en activar; són els que es desactiven en desactivar).
Perfils el cribratge AML existent dels quals passarà a estar monitorat (sense nou cribratge).
Perfils sense cap cribratge AML als quals es farà primer un cribratge (facturat com un cribratge AML ordinari).
Perfils que no es poden sotmetre a cribratge perquè manquen dades d'identitat.
Usuaris bloquejats que s'ometran (sempre 0 per a empreses).
Cost únic dels nous cribratges.
0.2
Cost de monitoratge anual dels perfils que passaran a estar monitorats.
0.07
Si el saldo de l'organització cobreix el cribratge més el primer any de monitoratge.
Identificadors de la sol·licitud que no coincideixen amb cap perfil d'aquesta aplicació, exactament tal com s'han enviat.