AML verifications

Create an AML verification

This endpoint allows you to create an AML verification. You should get a 201 response.

post/v2/aml-verifications

Request

Request body

webhook_urlstring uri
applicant_idstring

Applicant unique identifier.

monitoredboolean

Example request

{
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "search_parameters": {
    "configuration_identifier": "12345678-1234-1234-1234-123456789012"
  }
}

Response

AML verification created

idstring required

AML verification unique identifier.

created_onstring date-time required

UTC Date time when the resource was created

modified_onstring date-time required

UTC Date time when the resource was modified

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

Status of the AML verification.

webhook_urlstring uri required
applicant_idstring required

Applicant unique identifier.

monitoredboolean

Example response

{
  "id": "amlv_tkoi5db4hryu5cei5vwoabr7we",
  "created_on": "2017-07-21T17:32:28Z",
  "modified_on": "2017-07-21T17:40:32Z",
  "applicant_id": "aplt_tkoi5db4hryu5cei5vwoabr7we",
  "search_parameters": {
    "configuration_identifier": "12345678-1234-1234-1234-123456789012"
  }
}

Changes

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