POST/AML

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": {...}
}

AML Screening Result Codes: For detailed information about the result field values (Not Screened, Red Flag) and risk levels, refer to the AML Database Sources and Codes documentation.

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 Code	Message	Description
`invalid_payload`	Invalid payload	The request payload is invalid.
`missing_parameter`	submissionId is required	A required parameter is missing.
`invalid_submissionId`	Cannot find submission.	The provided Submission ID is invalid.
`invalid_country`	The nationality is invalid: `{nationality}`	The specified nationality is invalid.
`request_failed`	Fail to search AML.	An unknown error occurred during AML search.
`invalid_aml_threshold`	Invalid 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.

Overview

API Reference

1. Endpoint

2. Authentification

3. Request Parameters

4. Request Example

5. Response

5-1. Success Response

5-2. Error Response

5-3. Error Codes

​1. Endpoint

​2. Authentification

​3. Request Parameters

​4. Request Example

​5. Response

​5-1. Success Response

​5-2. Error Response

​5-3. Error Codes

1. Endpoint

2. Authentification

3. Request Parameters

4. Request Example

5. Response

5-1. Success Response

5-2. Error Response

5-3. Error Codes