GET/AML/Report

Notes

The resourceId can be obtained through the GET/submission API.
Multiple resourceIds may exist for a single submission (in case of multiple matches).
The resourceId is only generated when the AML screening result is 'Red Flag'.

AML Screening Result Codes: For detailed information about Red Flag and risk levels, refer to the AML Database Sources and Codes documentation.

1. Endpoint

GET https://rest-api.argosidentity.com/v3/report/aml

GET https://kr.rest-api.argosidentity.com/v3/report/aml

Include the API key in the x-api-key header:

x-api-key

x-api-key: {yourAPIKey}

string

required

Unique identifier for the selected AML screening result.

curl --location --request GET 'https://rest-api.argosidentity.com/v3/report/aml?resourceId={resourceId}' \
--header 'x-api-key: {yourAPIKey}'

curl --location --request GET 'https://kr.rest-api.argosidentity.com/v3/report/aml?resourceId={resourceId}' \
--header 'x-api-key: {yourAPIKey}'

A successful request will return the AML report in PDF format:

If an error occurs, the response has a 403 status code and the error message in the body:

error.json

{
    "message": "Missing required data : resourceId"
}

Condition	HTTP Status	Response
All query parameters are missing	403	`{"message":"Missing required data"}`
Query is present but `resourceId` is missing	403	`{"message":"Missing required data : resourceId"}`
The resource does not exist or the report lookup failed	403	`{"message":"get Pdf or editPdf err."}`

This API allows for efficient retrieval and downloading of detailed AML screening result reports.