Create a new AML Screening Request

POST

/v2/aml

Solicitud

Autorización

Proporciona tu token bearer en el encabezado

Authorization

al realizar solicitudes a recursos protegidos.

Ejemplo:

Authorization: Bearer ********************

Parámetros del Body application/json

Ejemplos

Respuestas

🟢201Creado

application/json

Request created successfully

Body

🟠400Solicitud incorrecta

🔴500Error interno del servidor

Ejemplo de Solicitud

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.veriflow.me/v2/aml' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fullName": "string",
    "dateOfBirth": "string",
    "nationality": "string",
    "documentNumber": "string",
    "amlScoreApproveThreshold": 0,
    "includeAdverseMedia": true,
    "includeOngoingMonitoring": true,
    "metadata": null
}'

Ejemplo de Respuesta

{
    "success": true,
    "payload": {
        "request": {
            "id": "string",
            "organizationId": "string",
            "type": "string",
            "status": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "cost": 0,
            "info": {
                "metadata": null,
                "init": {
                    "fullName": "string",
                    "dateOfBirth": "string",
                    "nationality": "string",
                    "documentNumber": "string",
                    "amlScoreApproveThreshold": 0,
                    "includeAdverseMedia": true,
                    "includeOngoingMonitoring": true,
                    "metadata": null
                },
                "response": {
                    "status": "string",
                    "totalHits": 0,
                    "score": 0,
                    "isOngoingMonitoringEnabled": true,
                    "nextOngoingMonitoringBillDate": null,
                    "screenedData": {
                        "fullName": "string",
                        "nationality": "string",
                        "dateOfBirth": "string",
                        "documentNumber": "string"
                    },
                    "warnings": [
                        {
                            "feature": "string",
                            "risk": "string",
                            "additionalData": null,
                            "logType": "string",
                            "shortDescription": "string",
                            "longDescription": "string"
                        }
                    ],
                    "hits": [
                        {
                            "id": "string",
                            "url": "http://example.com",
                            "match": true,
                            "score": 0,
                            "target": null,
                            "caption": "string",
                            "features": null,
                            "rcaName": "string",
                            "lastSeen": "string",
                            "riskView": null,
                            "firstSeen": "string",
                            "matchScore": 0,
                            "adverseMediaDetails": null,
                            "datasets": [
                                "string"
                            ],
                            "properties": {
                                "property1": null,
                                "property2": null
                            },
                            "pepMatches": [
                                null
                            ],
                            "linkedEntities": [
                                null
                            ],
                            "warningMatches": [
                                null
                            ],
                            "sanctionMatches": [
                                null
                            ],
                            "adverseMediaMatches": [
                                null
                            ],
                            "additionalInformation": {
                                "property1": null,
                                "property2": null
                            }
                        }
                    ]
                }
            }
        }
    }
}

Modificado en 2025-12-06 17:47:50

Create a new Proof of Address Request

Create a new Face Search Request