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
}
}API Aktifkan Pemantauan AML untuk Bisnis
Aktifkan atau nonaktifkan Pemantauan AML Berkelanjutan untuk banyak bisnis sekaligus lewat Didit: estimasi biaya, job, dan hasil per bisnis.
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
}
}Ikhtisar
Mengaktifkan atau menonaktifkan pemantauan AML berkelanjutan untuk entitas bisnis yang dipilih, persis seperti tindakan Pemantauan AML Berkelanjutan di Business Console. Console dan endpoint ini menjalankan operasi dasar yang sama, sehingga aturan, penagihan, dan hasilnya identik. Kirimestimate_only: true terlebih dahulu untuk melihat berapa banyak bisnis yang dipilih, berapa yang memerlukan skrining AML baru, biaya skrining sekali bayar, dan biaya pemantauan tahunan. Uji coba tidak menulis apa pun. Estimasi menggunakan nama kolom yang sama dengan endpoint pengguna, jadi users_total adalah jumlah bisnis yang dipilih.
Cara pemilihan diproses
- Satu skrining yang dipantau per bisnis. Perusahaan yang telah diverifikasi beberapa kali dipantau dan ditagih satu kali. Menonaktifkan pemantauan akan mematikan pemantauan di semua skrining milik bisnis tersebut.
- Bisnis tanpa skrining AML akan diskrining terlebih dahulu. Didit membuat verifikasi AML baru untuk bisnis tersebut (dapat dilihat di tab Verifikasi bisnis), ditagih sebagai skrining AML biasa, dan mengaktifkan pemantauan padanya. Skrining menggunakan nama legal bisnis (atau nama tampilan) dan negaranya. Bisnis yang tidak memiliki nama sama sekali dilaporkan sebagai
skipped_no_identity_datadan tidak dihilangkan secara diam-diam. - Aplikasi sandbox tidak pernah membuat skrining (
skipped_sandbox). - Saldo diperiksa di awal. Pengaktifan ditolak dengan
403jika saldo Anda tidak mencukupi estimasi, dan respons menyertakan estimasi sehingga Anda tahu berapa jumlah yang perlu diisi saldo. - Perpanjangan tahunan. Bisnis yang baru dipantau ditagih harga pemantauan tahunan pada tanggal perpanjangan berikutnya, yaitu tanggal yang ditampilkan Console di kolom Pemantauan berkelanjutan. Menonaktifkan pemantauan akan menghentikan perpanjangan; tidak ada pengembalian dana untuk periode yang sudah ditagih.
Pemilihan dan ukuran batch
Pilih bisnis denganvendor_data_list, didit_internal_id_list, atau keduanya; kedua daftar digabungkan dengan OR. Satu permintaan menerima paling banyak 1000 pengenal dari kedua daftar. Pengenal yang tidak cocok dengan bisnis mana pun di aplikasi Anda dikembalikan di unmatched persis seperti yang dikirim, dan tidak pernah menyebabkan permintaan gagal: pilihan yang tidak cocok dengan apa pun akan selesai sebagai tugas kosong (total: 0) dengan semua pengenal tercantum, sesuai dengan konvensi endpoint penghapusan batch.
Sinkron atau di latar belakang
Pilihan 20 bisnis atau kurang diproses secara sinkron dan panggilan mengembalikan200 beserta tugas yang sudah selesai. Pilihan yang lebih besar mengembalikan 202 dengan tugas PENDING; lakukan polling pada Dapatkan Tugas Pemantauan AML hingga status berubah menjadi COMPLETED atau FAILED. Dalam kedua kasus, tugas memuat satu entri results untuk setiap bisnis beserta hasilnya di kolom outcome.
outcome | Arti |
|---|---|
enabled | Pemantauan diaktifkan pada skrining AML yang sudah ada. |
screened_and_enabled | Skrining AML baru dibuat (ditagih) dan pemantauan diaktifkan padanya. |
already_enabled | Pemantauan sudah aktif; tidak ada yang berubah, tidak ada yang ditagih. |
disabled | Pemantauan dimatikan di semua skrining milik bisnis. |
skipped_no_identity_data | Bisnis tidak memiliki nama legal atau nama tampilan untuk diskrining. |
skipped_sandbox | Aplikasi sandbox; tidak ada skrining yang dibuat. |
failed_provider | Skrining tidak dapat diselesaikan. Coba lagi nanti. |
failed_insufficient_balance | Saldo habis saat tugas sedang berjalan. |
Webhook
Mengubah pemantauan tidak mengirimkan webhook tersendiri. Setelah pemantauan aktif, skrining ulang tetap mengirimkan eventstatus.updated dan data.updated seperti yang dijelaskan di Pemantauan AML Berkelanjutan.
Izin
Setiap kunci API aktif milik aplikasi dapat memanggil endpoint ini. Kunci API Didit bersifat terbatas pada aplikasi, bukan berdasarkan peran: peran dan izin di Console menentukan apa yang dapat dilakukan seseorang di Console, dan aturan tersebut tidak dievaluasi untuk lalu lintas Management API.Terkait
- Dapatkan Tugas Pemantauan AML
- Aktifkan atau Nonaktifkan Pemantauan AML untuk Pengguna
- Pemantauan AML Berkelanjutan
- Skrining AML bisnis
- Daftar Bisnis
Otorisasi
Kunci API aplikasi Anda, dari Developers -> API keys di Business Console. Kunci utama memiliki akses penuh. Kunci bernama dapat diberi cakupan: none, read, atau write per sumber daya, dibatasi pada beberapa alur kerja atau pada sesi yang disetujui, pada daftar alamat IP, dan pada tanggal kedaluwarsa. 401 berarti kuncinya salah, dicabut, atau kedaluwarsa; 403 berarti tidak ada kunci yang dikirimkan, kunci tidak memiliki akses ke sumber daya atau tindakan ini, atau permintaan datang dari alamat di luar daftar IP-nya; 404 pada rute sesi berarti sesi berada di luar alur kerja atau status kunci tersebut. Kunci tanpa akses media menerima URL gambar, video, dan PDF sebagai null, dan kunci tanpa izin tulis sesi menerima tautan sesi dan token sebagai null. Lihat https://docs.didit.me/console/api-keys.
Body
Pilih bisnis dengan vendor_data_list, didit_internal_id_list, atau keduanya (kedua daftar digabungkan dengan OR). Maksimal 1000 pengidentifikasi per permintaan di kedua daftar.
true untuk mengaktifkan pemantauan, false untuk menonaktifkannya.
Jika true, mengembalikan estimasi biaya dan tidak melakukan penulisan data - tanpa skrining, tanpa penagihan, tanpa membuat job.
Pengenal Anda sendiri untuk bisnis yang akan dialihkan statusnya, dicocokkan persis seperti yang dikirimkan.
ID internal Didit dari bisnis yang akan dialihkan statusnya - didit_internal_id yang dikembalikan oleh endpoint pembuatan, pengambilan, dan daftar.
Respons
Estimasi (jika estimate_only bernilai true) atau pekerjaan yang telah selesai untuk pilihan yang diproses secara inline.
- Option 1
- Option 2
Pratinjau biaya. Dikembalikan secara langsung saat estimate_only bernilai true (tidak ada yang ditulis).
Profil yang cocok dengan pilihan.
Profil yang sudah dipantau (tidak ada tindakan saat mengaktifkan; ini adalah profil yang dimatikan saat dinonaktifkan).
Profil yang skrining AML-nya yang sudah ada akan dialihkan ke dipantau (tanpa skrining baru).
Profil tanpa skrining AML apa pun yang akan diskrining terlebih dahulu (ditagih sebagai skrining AML reguler).
Profil yang tidak dapat diskrining karena data identitas tidak tersedia.
Pengguna terblokir yang akan dilewati (selalu 0 untuk bisnis).
Biaya sekali bayar untuk skrining baru.
0.2
Biaya pemantauan tahunan dari profil yang akan dipantau.
0.07
Apakah saldo organisasi mencukupi untuk skrining ditambah tahun pertama pemantauan.
Pengenal permintaan yang tidak cocok dengan profil apa pun di aplikasi ini, persis seperti yang dikirim.