CHcheckout
AML Screening

Create an AML screening

<span style="font-size: 12px; font-weight: 500; color: rgb(0, 0, 0); background-color: rgb(255, 176, 97); border-radius: 4px; padding: 2px 6px" >Beta</span><p></p> Create an AML screening.

If the request is successful, you receive a 201 Created response with the AML screening resource.

post/aml-verifications

Request

Request body

created_onstring date-time required

The date and time when the resource was created, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

modified_onstring date-time required

The date and time when the resource was modified, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

status'created' | 'screening_in_progress' | 'approved' | 'declined' | 'review_required' required

The screening status.

applicant_idstring required

The applicant's unique identifier.

monitoredboolean

Indicates whether to continue to monitor the applicant's AML status.

idstring required

The AML screening's unique identifier.

Example request

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "search_parameters": {
    "configuration_identifier": "12345678-1234-1234-1234-123456789012"
  },
  "id": "amlv_tkoi5db4hryu5cei5vwoabr7we"
}

Response

AML screening created successfully

created_onstring date-time required

The date and time when the resource was created, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

modified_onstring date-time required

The date and time when the resource was modified, in UTC. <br/>Format – yyyy-mm-ddThh:mm:ss.sss

status'created' | 'screening_in_progress' | 'approved' | 'declined' | 'review_required' required

The screening status.

applicant_idstring required

The applicant's unique identifier.

monitoredboolean

Indicates whether to continue to monitor the applicant's AML status.

idstring required

The AML screening's unique identifier.

Example response

{
  "created_on": "2025-07-21T17:32:28.0000000+00:00",
  "modified_on": "2025-07-21T17:40:32.0000000+00:00",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "search_parameters": {
    "configuration_identifier": "12345678-1234-1234-1234-123456789012"
  },
  "id": "amlv_tkoi5db4hryu5cei5vwoabr7we"
}

Changes

No recorded changes to this operation across all 1 revision of this API.