POST/AML

1. Endpoint

POST/AML

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

2. Autenticación

Incluya la clave API en el encabezado x-api-key:

x-api-key

x-api-key: {yourAPIKey}

3. Parámetros de Solicitud

string

requerido

ID único del submission.

int

Umbral de filtrado de la lista de vigilancia AML.

4. Ejemplo de Solicitud

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. Respuesta

5-1. Respuesta Exitosa

result.json

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

Códigos de Resultado de Evaluación AML: Para más detalles sobre los valores del campo result (Not Screened, Red Flag) y los niveles de riesgo, consulte la documentación de Fuentes y Códigos de la Base de Datos AML.

5-2. Respuesta de Error

Si ocurre un error, la respuesta incluirá un código de estado 400 con detalles en el siguiente formato:

error.json

{
    "errorCode": "invalid_payload",
    "message": "Invalid payload."
}

5-3. Códigos de Error

Error Code	Message	Descripción
`invalid_payload`	Invalid payload	El payload de la solicitud no es válido.
`missing_parameter`	submissionId is required	Falta un parámetro obligatorio.
`invalid_submissionId`	Cannot find submission.	El Submission ID proporcionado no es válido.
`invalid_country`	The nationality is invalid: `{nationality}`	La nacionalidad especificada no es válida.
`request_failed`	Fail to search AML.	Se produjo un error desconocido durante la búsqueda AML.
`invalid_aml_threshold`	Invalid AML Threshold.	El parámetro `amlThreshold` no se envió o no se configuró el umbral de la lista de vigilancia en el dashboard.

Esta API permite ejecutar una evaluación AML para un submission específico. Consulte los códigos de error anteriores para diagnosticar problemas.

Descripción General

Referencia API

1. Endpoint

2. Autenticación

3. Parámetros de Solicitud

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Respuesta de Error

5-3. Códigos de Error

​1. Endpoint

​2. Autenticación

​3. Parámetros de Solicitud

​4. Ejemplo de Solicitud

​5. Respuesta

​5-1. Respuesta Exitosa

​5-2. Respuesta de Error

​5-3. Códigos de Error

1. Endpoint

2. Autenticación

3. Parámetros de Solicitud

4. Ejemplo de Solicitud

5. Respuesta

5-1. Respuesta Exitosa

5-2. Respuesta de Error

5-3. Códigos de Error