curl -X POST 'https://verification.didit.me/v3/businesses/aml-monitoring/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"is_enabled": true, "vendor_data_list": ["company-123", "company-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.set_aml_monitoring(
is_enabled=True,
estimate_only=True,
vendor_data_list=["company-123", "company-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.setAmlMonitoring({
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.SetAMLMonitoring(ctx, didit.BusinessesSetAMLMonitoringParams{
IsEnabled: true,
EstimateOnly: didit.Bool(true),
VendorDataList: didit.Some([]string{"company-123", "company-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BusinessesSetAmlMonitoringParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().setAmlMonitoring(BusinessesSetAmlMonitoringParams.builder()
.isEnabled(true)
.estimateOnly(true)
.vendorDataList(List.of("company-123", "company-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->setAmlMonitoring([
'is_enabled' => true,
'estimate_only' => true,
'vendor_data_list' => ['company-123', 'company-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.set_aml_monitoring(
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-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.Businesses.SetAmlMonitoringAsync(new BusinessesSetAmlMonitoringParams
{
IsEnabled = true,
EstimateOnly = true,
VendorDataList = new string[] { "company-123", "company-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
}
}Monitoratge AML per a empreses: activar o desactivar API
Activa o desactiva el monitoratge AML de diverses empreses en una crida de l’API de Didit, amb estimació de cost i resultat per empresa.
curl -X POST 'https://verification.didit.me/v3/businesses/aml-monitoring/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"is_enabled": true, "vendor_data_list": ["company-123", "company-456"]}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.businesses.set_aml_monitoring(
is_enabled=True,
estimate_only=True,
vendor_data_list=["company-123", "company-456"],
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.businesses.setAmlMonitoring({
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-456"],
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Businesses.SetAMLMonitoring(ctx, didit.BusinessesSetAMLMonitoringParams{
IsEnabled: true,
EstimateOnly: didit.Bool(true),
VendorDataList: didit.Some([]string{"company-123", "company-456"}),
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import java.util.List;
import me.didit.Didit;
import me.didit.types.BusinessesSetAmlMonitoringParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.businesses().setAmlMonitoring(BusinessesSetAmlMonitoringParams.builder()
.isEnabled(true)
.estimateOnly(true)
.vendorDataList(List.of("company-123", "company-456"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->businesses->setAmlMonitoring([
'is_enabled' => true,
'estimate_only' => true,
'vendor_data_list' => ['company-123', 'company-456'],
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.businesses.set_aml_monitoring(
is_enabled: true,
estimate_only: true,
vendor_data_list: ["company-123", "company-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.Businesses.SetAmlMonitoringAsync(new BusinessesSetAmlMonitoringParams
{
IsEnabled = true,
EstimateOnly = true,
VendorDataList = new string[] { "company-123", "company-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 empreses seleccionades, exactament com l’acció Monitoratge AML continu de la Business Console. La Console 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 quantes empreses estan seleccionades, quantes necessiten un nou Cribratge AML, el cost únic del cribratge i el cost anual del monitoratge. Una execució de prova no escriu res. L’estimació fa servir els mateixos noms de camp que l’endpoint d’usuaris, de manera que users_total és el nombre d’empreses seleccionades.
Com es processa una selecció
- Un cribratge monitoritzat per empresa. Una empresa que s’ha verificat diverses vegades es monitoritza i es factura una sola vegada. Desactivar-lo desactiva el monitoratge en tots els cribratges d’aquesta empresa.
- Les empreses sense cribratge AML se sotmeten primer a un cribratge. Didit crea un nou Cribratge AML per a elles (visible a la pestanya Verificacions de l’empresa), facturat com un Cribratge AML habitual, i hi activa el monitoratge. El cribratge utilitza el nom legal (o nom de visualització) i el país de l’empresa. Una empresa sense cap nom es informa com a
skipped_no_identity_dataen lloc de descartar-se en silenci. - Les aplicacions de sandbox mai creen cribratges (
skipped_sandbox). - El saldo es comprova per endavant. L’activació es rebutja amb
403quan el saldo no cobreix l’estimació, i la resposta inclou l’estimació perquè sàpigues quant cal recarregar. - Renovació anual. Una empresa que comença a estar monitoritzada es factura al preu anual de monitoratge en la seva propera data de renovació, la mateixa que la Console mostra a la columna Monitoratge continu. Desactivar-lo atura la renovació; no reembossa cap període ja facturat.
Selecció i mida del lot
Selecciona empreses 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 coincideixen amb cap empresa de la teva aplicació es retornen a unmatched, tal com s’han enviat, i mai no fan fallar la sol·licitud: una selecció sense coincidències es completa com a tasca buida (total: 0) amb tots els identificadors indicats, igual que als endpoints d’eliminació en lot.
En línia o en segon pla
Les seleccions de 20 empreses 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 porta una entrada results per empresa amb el seu resultat 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 ni s’ha facturat res. |
disabled | Monitoratge desactivat en tots els cribratges de l’empresa. |
skipped_no_identity_data | L’empresa no té cap nom legal ni de visualització per sotmetre-la a un cribratge. |
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 s’executava la tasca. |
Webhooks
Activar o desactivar el monitoratge no emet cap webhook propi. Un cop el monitoratge s’ha activat, els recribratges continuen generant 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 abast d’aplicació, no de 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.Relacionats
- Obtenir la tasca de monitoratge AML
- Activar o desactivar el monitoratge AML per als usuaris
- Monitoratge AML continu
- Cribratge AML d’empreses
- Llistar empreses
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 empreses 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 de les empreses a commutar, coincidits exactament com es van enviar.
ID interns de Didit de les empreses 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.