Create a new ID Verification Request

POST

/v2/id-verification

This endpoint creates a new ID Verification request.

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/id-verification' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "frontImage": "string",
    "backImage": "string",
    "performDocumentLiveness": true,
    "minimumAge": 0,
    "metadata": null,
    "expirationDateNotDetectedAction": "NO_ACTION",
    "invalidMrzAction": "NO_ACTION",
    "inconsistentDataAction": "NO_ACTION"
}'

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": {
                    "frontImage": "string",
                    "backImage": "string",
                    "performDocumentLiveness": true,
                    "minimumAge": 0,
                    "metadata": null,
                    "expirationDateNotDetectedAction": "NO_ACTION",
                    "invalidMrzAction": "NO_ACTION",
                    "inconsistentDataAction": "NO_ACTION"
                },
                "response": {
                    "status": "string",
                    "documentType": "string",
                    "documentNumber": "string",
                    "personalNumber": "string",
                    "portraitImage": "http://example.com",
                    "frontImage": "http://example.com",
                    "frontVideo": "http://example.com",
                    "backImage": "http://example.com",
                    "backVideo": "http://example.com",
                    "fullFrontImage": "http://example.com",
                    "fullBackImage": "http://example.com",
                    "dateOfBirth": "string",
                    "age": 0,
                    "expirationDate": "string",
                    "dateOfIssue": "string",
                    "issuingState": "string",
                    "issuingStateName": "string",
                    "firstName": "string",
                    "lastName": "string",
                    "fullName": "string",
                    "gender": "string",
                    "address": "string",
                    "formattedAddress": "string",
                    "placeOfBirth": "string",
                    "maritalStatus": "string",
                    "nationality": "string",
                    "extraFields": {
                        "property1": null,
                        "property2": null
                    },
                    "extraFiles": [
                        "http://example.com"
                    ],
                    "warnings": [
                        {
                            "feature": "string",
                            "risk": "string",
                            "additionalData": null,
                            "logType": "string",
                            "shortDescription": "string",
                            "longDescription": "string"
                        }
                    ],
                    "parsedAddress": {
                        "id": "string",
                        "rawResults": null,
                        "addressType": "string",
                        "city": "string",
                        "label": "string",
                        "region": "string",
                        "street1": "string",
                        "street2": "string",
                        "postalCode": "string",
                        "country": "string",
                        "documentLocation": {
                            "latitude": 0,
                            "longitude": 0
                        }
                    }
                }
            }
        }
    }
}

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

Fetch all requests for the authenticated organization

Create a new Face Match Request