Skip to main content
POST
/
api
/
v1
/
verification
/
aml
Watchlist and AML screening
curl --request POST \
  --url https://{environment-subdomain}.idmetagroup.com/api/v1/verification/aml \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dob": "1990-05-15",
  "gender": "<string>",
  "template_id": "{your_trust_flow_id}",
  "verification_id": "{your_created_verification_id}"
}
'
{
  "status": true,
  "message": "OK",
  "result": {
    "results": {
      "matchCount": 39,
      "matches": [
        {
          "qrCode": "3360148",
          "resourceId": "96e3b2e2...",
          "score": 98,
          "match": "John Doe",
          "name": "John Doe",
          "countries": [
            "GB"
          ],
          "addresses": [
            {
              "geography": "GB",
              "city": "Slough"
            }
          ],
          "datasets": [
            "REL"
          ],
          "gender": "Male",
          "resourceUri": "/individuals/96e3b2e2..."
        },
        {
          "qrCode": "10262301",
          "resourceId": "4d3dd373...",
          "score": 85,
          "match": "John Deo",
          "name": "John Deo",
          "countries": [
            "FJ"
          ],
          "addresses": [
            {
              "geography": "FJ"
            }
          ],
          "datasets": [
            "POI"
          ],
          "gender": "Male",
          "profileImage": "https://.../qe__8tn3.PNG",
          "resourceUri": "/individuals/4d3dd373..."
        },
        {
          "qrCode": "5868428",
          "resourceId": "f1cf2dc6...",
          "score": 81,
          "match": "John",
          "name": "John Ryan",
          "countries": [
            "NZ"
          ],
          "addresses": [
            {
              "geography": "NZ",
              "city": "Wellington"
            }
          ],
          "datasets": [
            "PEP-FORMER"
          ],
          "pepTier": "PEP Tier 1",
          "gender": "Male",
          "profileImage": "https://.../XYWVJMbKmfJ7aOiJ1n_NC.jpeg",
          "resourceUri": "/individuals/f1cf2dc6..."
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.idmetagroup.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use Bearer {your_api_token} in the Authorization header.

Headers

​
Accept
string
default:application/json
​
Content-Type
string
default:application/json

Body

application/json
​
name
string
required

Full name of the individual to be screened.

​
template_id
string
required

Identifier for categorizing or tracking verification templates.

​
verification_id
string
required

Unique ID to track the specific verification session or request.

​
dob
string

Date of birth of the individual.

​
gender
string

Gender of the individual.

Response

200 - application/json

AML screening completed successfully

​
status
boolean
​
message
string
​
result
object