Validación del documento (morfología) v1

/documentValidation

Esta API permite el proceso de validación morfológica de documentos de identidad.

El proceso consta de 3 pasos:

Inicio: se envían la información del documento (imágenes, país y tipo de documento) a analizar. Estado: se consulta el estado de la operación para ver si es posible proceder a obtener el resultado de la misma. Esta consulta debe realizarse *n* veces hasta que la operación de análisis haya finalizado. Datos: se obtienen los resultados del análisis morfológico del documento.

---

Inicio (Start)

Solicitud de inicio de validación morfológica:

bash

curl --location '{IDENTITY_API_BASE_URL}/verify/documentValidation/start' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
    "country": "{COUNTRY_CODE}",
    "idType": "{ID_TYPE}",
    "frontsideImage": "{FRONTSIDE_IMAGE}",
    "backsideImage": "{BACKSIDE_IMAGE}",
    "merchantIdScanReference": "{SCAN_REFERENCE}"
}'

Parámetros de la solicitud:

Campo	Requerido	Descripción
COUNTRY_CODE	Sí	Código de país ISO 3166-1 alpha-3
ID_TYPE	Sí	Tipo de identificación proporcionada. Valores permitidos: PASSPORT, DRIVING_LICENSE, ID_CARD, VISA
FRONTSIDE_IMAGE	Sí	Imagen del anverso del documento codificada en Base64 (abierta o tokenizada)
BACKSIDE_IMAGE	No	Imagen del reverso del documento codificada en Base64 (abierta o tokenizada). Opcional para documentos de una sola cara como el PASSPORT
SCAN_REFERENCE	No	Referencia personalizada de la operación. Longitud máx.: 100 caracteres

Respuesta de ejemplo:

200 OK

Content-Type: application/json

json

{
    "timestamp": "1970-01-01T00:00:00.000Z",
    "scanReference": "fe294c25-17e1-4d98-a958-710edbf00064",
    "type": "1"
}

Campos de la respuesta:

Campo	Descripción
timestamp	Marca de tiempo (UTC) de la respuesta en formato ISO 8601
scanReference	Número de referencia para cada escaneo
type	Valor obsoleto. Se eliminará en futuras versiones

---

Estado (Status)

Solicitud de estado de la validación morfológica:

bash

curl --location '{IDENTITY_API_BASE_URL}/verify/documentValidation/status' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
    "scanReference": "{SCAN_REFERENCE}",
    "type": "{TYPE}"
}'

Parámetros de la solicitud:

Campo	Requerido	Descripción
SCAN_REFERENCE	Sí	Número de referencia del escaneo
TYPE	No	Valor obsoleto. Se eliminará en futuras versiones

Respuesta de ejemplo:

200 OK

Content-Type: application/json

json

{
    "timestamp": "1970-01-01T00:00:00.000Z",
    "scanReference": "fe294c25-17e1-4d98-a958-710edbf00064",
    "status": "DONE"
}

Campos de la respuesta:

Campo	Descripción
timestamp	Marca de tiempo (UTC) de la respuesta en formato ISO 8601
scanReference	Número de referencia del escaneo
status	Estado de la operación. Estados posibles: PENDING (Pendiente), DONE (Terminado), FAILED (Fallido)

---

Datos (Data)

Solicitud de datos de la validación morfológica:

bash

curl --location '{IDENTITY_API_BASE_URL}/verify/documentValidation/data' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
    "scanReference": "{SCAN_REFERENCE}",
    "type": "{TYPE}"
}'

Parámetros de la solicitud:

Campo	Requerido	Descripción
SCAN_REFERENCE	Sí	Número de referencia del escaneo
TYPE	No	Valor obsoleto. Se eliminará en futuras versiones

Respuesta de ejemplo:

Nota: Los campos de respuesta dependerán del proveedor de morfología configurado.