curl -X PATCH \
https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-hit-status/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"hit_id": "abc123",
"review_status": "False Positive"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id="hit_7c1e9a40b2d35f86e0a4c912",
review_status="False Positive",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.updateAmlHitStatus("11111111-2222-3333-4444-555555555555", {
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.UpdateAMLHitStatus(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsUpdateAMLHitStatusParams{
HitID: "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus: "False Positive",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SessionsUpdateAmlHitStatusParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().updateAmlHitStatus("11111111-2222-3333-4444-555555555555", SessionsUpdateAmlHitStatusParams.builder()
.hitId("hit_7c1e9a40b2d35f86e0a4c912")
.reviewStatus(SessionsUpdateAmlHitStatusParams.ReviewStatus.of("False Positive"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->updateAmlHitStatus('11111111-2222-3333-4444-555555555555', [
'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',
'review_status' => 'False Positive',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.UpdateAmlHitStatusAsync("11111111-2222-3333-4444-555555555555", new SessionsUpdateAmlHitStatusParams
{
HitId = "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus = "False Positive",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"message": "Hit status updated successfully",
"hit_id": "hit_7c1e9a40b2d35f86e0a4c912",
"review_status": "False Positive"
}AML हिट स्थिति अपडेट API: मिलान की पुष्टि और क्लियर करें
Didit API से AML स्क्रीनिंग हिट को व्यक्तिगत या बल्क में पुष्ट मिलान, फ़ॉल्स पॉज़िटिव या अनिर्णायक के रूप में चिह्नित करें।
curl -X PATCH \
https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-hit-status/ \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"hit_id": "abc123",
"review_status": "False Positive"
}'from didit import Didit
# Reads DIDIT_API_KEY.
client = Didit()
result = client.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id="hit_7c1e9a40b2d35f86e0a4c912",
review_status="False Positive",
)
print(result)import Didit from "@didit-protocol/sdk-node";
// Reads DIDIT_API_KEY.
const didit = new Didit();
const result = await didit.sessions.updateAmlHitStatus("11111111-2222-3333-4444-555555555555", {
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive",
});
console.log(result);ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()
result, err := client.Sessions.UpdateAMLHitStatus(ctx, "11111111-2222-3333-4444-555555555555", didit.SessionsUpdateAMLHitStatusParams{
HitID: "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus: "False Positive",
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("%+v\n", result)import me.didit.Didit;
import me.didit.types.SessionsUpdateAmlHitStatusParams;
// Reads DIDIT_API_KEY.
Didit client = new Didit();
var result = client.sessions().updateAmlHitStatus("11111111-2222-3333-4444-555555555555", SessionsUpdateAmlHitStatusParams.builder()
.hitId("hit_7c1e9a40b2d35f86e0a4c912")
.reviewStatus(SessionsUpdateAmlHitStatusParams.ReviewStatus.of("False Positive"))
.build());
System.out.println(result);<?php
require 'vendor/autoload.php';
use Didit\DiditClient;
// Reads DIDIT_API_KEY.
$didit = new DiditClient();
$result = $didit->sessions->updateAmlHitStatus('11111111-2222-3333-4444-555555555555', [
'hit_id' => 'hit_7c1e9a40b2d35f86e0a4c912',
'review_status' => 'False Positive',
]);
print_r($result->toArray());require "didit"
# Reads DIDIT_API_KEY.
didit = Didit::Client.new
result = didit.sessions.update_aml_hit_status(
"11111111-2222-3333-4444-555555555555",
hit_id: "hit_7c1e9a40b2d35f86e0a4c912",
review_status: "False Positive"
)
puts result.to_husing System;
using System.Text.Json;
using Didit;
// Reads DIDIT_API_KEY.
using var client = new DiditClient();
var result = await client.Sessions.UpdateAmlHitStatusAsync("11111111-2222-3333-4444-555555555555", new SessionsUpdateAmlHitStatusParams
{
HitId = "hit_7c1e9a40b2d35f86e0a4c912",
ReviewStatus = "False Positive",
});
Console.WriteLine(JsonSerializer.Serialize(result));{
"message": "Hit status updated successfully",
"hit_id": "hit_7c1e9a40b2d35f86e0a4c912",
"review_status": "False Positive"
}यह क्या करता है
AML स्क्रीनिंग से हिट की एक सूची मिलती है, यानी प्रतिबंध सूचियों, PEP डेटाबेस, वॉचलिस्ट और प्रतिकूल मीडिया से संभावित मिलान। हर हिट में एकreview_status होता है (उसका निपटारा), जो मिलान स्कोर के आधार पर Unreviewed या False Positive से शुरू होता है। यह endpoint आपकी टीम (या आपके ऑटोमेशन) को हर हिट पर निर्णय दर्ज करने देता है, बिना समग्र सत्र निर्णय बदले।
हिट और उनके ID सत्र के निर्णय में खोजें, यानी AML जाँच का hits array, जहाँ हर हिट का id ही वह hit_id है जो आप यहाँ भेजते हैं।
हिट का id hit_ से शुरू होता है, उसके बाद 24 हेक्साडेसिमल अक्षर आते हैं, और विषय की दोबारा स्क्रीनिंग होने पर भी यह वही रहता है। पुराने प्रारूप में लौटाया गया हिट ID अब भी स्वीकार किया जाता है; रिस्पॉन्स में हिट हमेशा उसके वर्तमान id से दिखाया जाता है।
समीक्षा स्टेटस
review_status | अर्थ |
|---|---|
Unreviewed | मिलान थ्रेशोल्ड के बराबर या उससे अधिक हिट के लिए डिफ़ॉल्ट। अभी भी निर्णय की ज़रूरत है। |
Confirmed Match | स्क्रीन किए गए व्यक्ति / इकाई का सही मिलान। |
False Positive | यह वही इकाई नहीं है। मिलान थ्रेशोल्ड से कम हिट के लिए डिफ़ॉल्ट। |
Inconclusive | निर्धारित नहीं किया जा सका। |
False Positive के रूप में चिह्नित करते हैं, वह स्थिति तब भी बनी रहती है जब प्रदाता इकाई की दोबारा स्क्रीनिंग करता है।एक हिट अपडेट करें
PATCH /v3/session/{sessionId}/update-aml-hit-status/
curl -X PATCH https://verification.didit.me/v3/session/4c5c7f3a-.../update-aml-hit-status/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"hit_id": "hit_7c1e9a40b2d35f86e0a4c912",
"review_status": "False Positive"
}'
?node_id=feature_aml_1 जोड़ें या बॉडी में "node_id" शामिल करें।
कई हिट एक साथ अपडेट करें
PATCH /v3/session/{sessionId}/bulk-update-aml-hit-status/
hit_updates पास करें, जो { hit_id, review_status } जोड़ियों की एक सूची है। यह ऑपरेशन सब-या-कुछ-नहीं है: यदि कोई hit_id नहीं मिलता, तो अनुरोध 404 लौटाता है और कोई भी हिट नहीं बदला जाता।
curl -X PATCH https://verification.didit.me/v3/session/4c5c7f3a-.../bulk-update-aml-hit-status/ \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"hit_updates": [
{ "hit_id": "hit_7c1e9a40b2d35f86e0a4c912", "review_status": "Confirmed Match" },
{ "hit_id": "hit_3b8f20d6a91c4e75f0b2d6a8", "review_status": "False Positive" }
]
}'
data.updated webhook भेजती है और सभी बदलावों को कवर करती हुई एक गतिविधि प्रविष्टि दर्ज करती है।
अपडेट के बाद क्या होता है
- Webhook: सत्र पर
data.updatedइवेंट भेजा जाता है। - ऑडिट रिकॉर्ड: बदलाव सत्र के समीक्षा रिकॉर्ड में कर्ता (API कुंजी या उपयोगकर्ता) के साथ दर्ज होता है, जो कंसोल की गतिविधि समयरेखा में दिखता है।
- AML चरण की समग्र स्थिति अप्रभावित रहती है: हिट का निपटारा बदलने से अपने आप AML चरण की स्थिति या सत्र का निर्णय नहीं बदलता। AML चरण की स्थिति (
Approved/Declined/In Review) बदलने के लिए update-feature-status का उपयोग करें। सत्र का निर्णय बदलने के लिए update-status का उपयोग करें।
KYC और KYB समर्थन
यह उपयोगकर्ता सत्यापन (KYC) और व्यवसाय सत्यापन (KYB) दोनों सत्रों के लिए काम करता है; Didit दोनों मेंsessionId को पहचानता है। KYB के लिए AML स्क्रीनिंग कंपनी और उसके प्रमुख व्यक्तियों पर चलती है; हर AML जाँच अपने अलग हिट दिखाती है।
अनुमति
इसके लिएwrite:sessions विशेषाधिकार चाहिए, और क्लाइंट API कुंजी (x-api-key) या उपयोगकर्ता प्राधिकरण हेडर में से कोई एक।
त्रुटियाँ
| स्टेटस | अर्थ |
|---|---|
400 | review_status मान मान्य नहीं है, hit_id खाली है, या hit_updates खाली है। |
403 | क्रेडेंशियल अनुपस्थित या अमान्य हैं, या कॉलर के पास write:sessions नहीं है। |
404 | सत्र नहीं मिला, सत्र में कोई AML जाँच नहीं है, या कोई hit_id नहीं मिला (बल्क में: कुछ भी नहीं बदला जाता)। |
संबंधित
- फ़ीचर स्थिति अपडेट करें: AML चरण की स्थिति (या कोई अन्य चरण) बदलें।
- सत्र स्थिति अपडेट करें: समग्र सत्र निर्णय बदलें।
- सत्र प्राप्त करें: AML
hitsऔर उनके ID पढ़ें। - AML स्क्रीनिंग: स्क्रीनिंग और स्कोरिंग कैसे काम करते हैं।
प्राधिकरण
आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।
पथ पैरामीटर
सत्यापन सत्र का UUID। उपयोगकर्ता (KYC) और व्यवसाय (KYB) दोनों सत्र ID स्वीकार करता है — सेवा दोनों सत्र प्रकारों में ID को रिज़ॉल्व करती है।
"11111111-2222-3333-4444-555555555555"
क्वेरी पैरामीटर
वर्कफ़्लो ग्राफ़ नोड ID। केवल तभी आवश्यक जब सत्र में कई AML चेक हों (प्रति नोड एक); एकल-AML सत्रों के लिए इसे छोड़ दें।
"feature_aml_1"
बॉडी
AML जांच के hits ऐरे (hit_...) में हिट का id। पूर्व प्रारूप में लौटाया गया हिट id अभी भी स्वीकार किया जाता है।
"hit_7c1e9a40b2d35f86e0a4c912"
हिट के लिए नई समीक्षा स्थिति।
Unreviewed, Confirmed Match, False Positive, Inconclusive "False Positive"
वैकल्पिक ग्राफ़ नोड ID। इसका उपयोग करें (यहाँ या क्वेरी पैरामीटर के रूप में) जब सत्र में एकाधिक AML जांचें हों।
"feature_aml_1"
प्रतिक्रिया
हिट समीक्षा स्थिति अपडेट की गई।
हमेशा Hit status updated successfully।
अपडेट किए गए हिट का id, जैसा कि सत्र निर्णय द्वारा लौटाया जाता है, तब भी जब अनुरोध ने पूर्व प्रारूप में किसी id द्वारा हिट को नामित किया हो।
हिट पर अब संग्रहीत समीक्षा स्थिति।
Unreviewed, Confirmed Match, False Positive, Inconclusive