POST/AML

Definition

  • AML Search is performed on already created submissions.

Input Data

ParameterTypeRequiredDescription

submissionId

String

O

Unique ID of submission (= submissionId)

Output Data

ResponseDescription

message

A message regarding the result of the request.

result

AML Search Results

raw_data

Returns an object with raw data from the AML screen result

Error Codes (400 error)

errorCodeMessageDescription

invalid_payload

Invalid payload.

Request body (payload) is not verified

missing_parameter

submissionId is required.

Required parameter is missing

invalid_submissionId

Cannot find submission.

Invalid Submission ID

invalid_country

The nationality is invalid : {nationality}

Invalid country name

request_failed

Fail to search AML.

Unknown error while processing data. (CS manager inquiry)

Request URL

  • You must enter the URL and x-api-key.

curl -X POST "<https://rest-api.argosidentity.com/v3/submission/aml>" \\
-H "x-api-key: {yourAPIKey}" \\

Sample Request

  • Submit in Body/Raw Json format.

  • Only one submission is allowed.

curl --location '<https://rest-api.argosidentity.com/v3/submission/aml>' \\
--header 'Content-Type: application/json' \\
--header 'x-api-key: {yourAPIKey}' \\
--data '{
    "submissionId" : "sampleSubmissionId11"
}'

Sample Response

{
    "message": "complete to search AML.",
    "result": "Not Screened",
    "raw_data" : {...}
}

Last updated