Create an AML screening
Beta
Create an AML screening.If the request is successful, you receive a 201 Created response with the AML screening resource.
SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
Request Body schema: application/jsonrequired
| applicant_id required | string^aplt_\w+$ The applicant's unique identifier. |
required | object (SearchParameters) The screening's configuration details. |
| monitored | boolean Indicates whether to continue to monitor the applicant's AML status. |
Responses
201
AML screening created successfully
post/aml-verifications
Request samples
- Payload
- curl
- Java
- C#
- Python
application/json
{- "search_parameters": {
- "configuration_identifier": "12345678-1234-1234-1234-123456789012"
}, - "monitored": true
}Response samples
- 201
application/json
{- "id": "amlv_tkoi5db4hryu5cei5vwoabr7we",
- "created_on": "2025-07-21T17:32:28Z",
- "modified_on": "2025-07-21T17:40:32Z",
- "status": "created",
- "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
- "search_parameters": {
- "configuration_identifier": "8eb79430-c014-41e5-be73-2c2c091322b8"
}, - "monitored": false,
- "_links": {
- "applicant": {
}
}
}Get an AML screening
Get the detailed result of an AML screening.
SecurityOAuth2: OAuth or API Key: ApiSecretKey
Request
Responses
200
AML screening retrieved successfully
get/aml-verifications/{aml_verification_id}
Request samples
- curl
- Java
- C#
- Python
Response samples
- 200
application/json
{- "id": "amlv_tkoi5db4hryu5cei5vwoabr7we",
- "created_on": "2025-07-21T17:32:28Z",
- "modified_on": "2025-07-21T17:40:32Z",
- "status": "created",
- "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
- "search_parameters": {
- "configuration_identifier": "8eb79430-c014-41e5-be73-2c2c091322b8"
}, - "monitored": false,
- "_links": {
- "applicant": {
}
}
}