curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "Approved"}'import os
import requests
session_id = '11111111-2222-3333-4444-555555555555'
resp = requests.patch(
f'https://verification.didit.me/v3/session/{session_id}/update-aml-status/',
headers={'x-api-key': os.environ['DIDIT_API_KEY']},
json={'status': 'Approved'},
timeout=10,
)
resp.raise_for_status()
body = resp.json()
print(body['previous_status'], '->', body['status'])const sessionId = '11111111-2222-3333-4444-555555555555';
const resp = await fetch(`https://verification.didit.me/v3/session/${sessionId}/update-aml-status/`, {
method: 'PATCH',
headers: { 'x-api-key': process.env.DIDIT_API_KEY, 'Content-Type': 'application/json' },
body: JSON.stringify({ status: 'Approved' }),
});
if (!resp.ok) throw new Error(`Update failed: ${resp.status}`);
const body = await resp.json();
console.log(body.previous_status, '->', body.status);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verification.didit.me/v3/session/{sessionId}/update-aml-status/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'Approved'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/session/{sessionId}/update-aml-status/"
payload := strings.NewReader("{\n \"status\": \"Approved\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://verification.didit.me/v3/session/{sessionId}/update-aml-status/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"Approved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/session/{sessionId}/update-aml-status/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"Approved\"\n}"
response = http.request(request)
puts response.read_body{
"message": "AML status updated successfully",
"status": "Approved",
"previous_status": "In Review"
}Update AML Check Status
Set the status of a session’s AML screening check, such as Approved after clearing its hits, without changing the overall session decision.
curl -X PATCH 'https://verification.didit.me/v3/session/11111111-2222-3333-4444-555555555555/update-aml-status/' \
-H 'x-api-key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"status": "Approved"}'import os
import requests
session_id = '11111111-2222-3333-4444-555555555555'
resp = requests.patch(
f'https://verification.didit.me/v3/session/{session_id}/update-aml-status/',
headers={'x-api-key': os.environ['DIDIT_API_KEY']},
json={'status': 'Approved'},
timeout=10,
)
resp.raise_for_status()
body = resp.json()
print(body['previous_status'], '->', body['status'])const sessionId = '11111111-2222-3333-4444-555555555555';
const resp = await fetch(`https://verification.didit.me/v3/session/${sessionId}/update-aml-status/`, {
method: 'PATCH',
headers: { 'x-api-key': process.env.DIDIT_API_KEY, 'Content-Type': 'application/json' },
body: JSON.stringify({ status: 'Approved' }),
});
if (!resp.ok) throw new Error(`Update failed: ${resp.status}`);
const body = await resp.json();
console.log(body.previous_status, '->', body.status);<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://verification.didit.me/v3/session/{sessionId}/update-aml-status/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => 'Approved'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://verification.didit.me/v3/session/{sessionId}/update-aml-status/"
payload := strings.NewReader("{\n \"status\": \"Approved\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://verification.didit.me/v3/session/{sessionId}/update-aml-status/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"Approved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://verification.didit.me/v3/session/{sessionId}/update-aml-status/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"Approved\"\n}"
response = http.request(request)
puts response.read_body{
"message": "AML status updated successfully",
"status": "Approved",
"previous_status": "In Review"
}Authorizations
Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.
Path Parameters
UUID of the verification session (the session_id returned by POST /v3/session/). Accepts both User Verification (KYC) and Business Verification (KYB) session IDs: the server resolves the ID across both session types. Must be a well-formed UUID; a malformed value does not match the route and returns an HTML 404.
"11111111-2222-3333-4444-555555555555"
Query Parameters
Workflow graph node ID of the AML check to update. Needed only when the session ran more than one AML step. Takes precedence over node_id in the body.
"feature_aml_1"
Body
Response
AML check status set (or unchanged when it already had this value).
Always AML status updated successfully.
Status of the AML check now.
Not Finished, Approved, Declined, In Review, Resub Requested Status before the call. Equal to status when nothing changed.
Not Finished, Approved, Declined, In Review, Resub Requested