Skip to main content

​
1. Endpoint

POST/AML
POST https://rest-api.argosidentity.com/v3/submission/aml

​
2. Authentification

Include the API key in the x-api-key header:
x-api-key
x-api-key: {yourAPIKey}

​
3. Request Parameters

​
submissionId
string
required
Unique ID of the submission.
​
amlThreshold
int
AML Watch list filtering’s threshold.

​
4. Request Example

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

​
5. Response

​
5-1. Success Response

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

​
5-2. Error Response

If an error occurs, the response will include a 400 status code with details in the following format:
error.json
{
    "errorCode": "invalid_payload",
    "message": "Invalid payload."
}

​
5-3. Error Codes

Error CodeMessageDescription
invalid_payloadInvalid payloadThe request payload is invalid.
missing_parametersubmissionId is requiredA required parameter is missing.
invalid_submissionIdCannot find submission.The provided Submission ID is invalid.
invalid_countryThe nationality is invalid: {nationality}The specified nationality is invalid.
request_failedFail to search AML.An unknown error occurred during AML search.
invalid_aml_thresholdInvalid AML Threshold.When amlThreshold parameter is omitted, or didn’t configure Watch list filtering’s score at Dashboard.
This API enables you to perform AML screening for a specific submission. Refer to the error codes provided to troubleshoot issues effectively.
⌘I