Validación del documento (morfología) v2
v2/documentValidation
Esta API permite el proceso de validación morfológica de documentos de identidad.
El proceso consta de 3 pasos:
Inicio (Start): se envía la información del documento (imágenes, país y tipo de documento) a analizar.
Estado (Status): se consulta el estado de la operación para ver si es posible proceder a obtener el resultado de la operación. Esta consulta debe realizarse n veces hasta que la operación de análisis haya finalizado.
Datos (Data): 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/v2/start' \
--header 'x-api-key: {API_KEY}' \
--header 'Content-Type: application/json' \
--data '{
"country": "{COUNTRY_CODE}",
"idType": "{ID_TYPE}",
"documentRawImageMimeType": "image/jpeg",
"documentFrontRawImage": "{FRONTSIDE_IMAGE}",
"documentBackRawImage": "{BACKSIDE_IMAGE}",
"merchantIdScanReference": "{SCAN_REFERENCE}"
}'Parámetros de la solicitud:
Campo
Obligatorio
Descripción
country
Sí
Código de país ISO 3166-1 alpha-3
idType
Sí
Tipo de identificación proporcionada. Valores permitidos: PASSPORT, DRIVING_LICENSE, ID_CARD, RESIDENCE_PERMIT, VISA
documentFrontRawImage
Sí
Imagen del frente del documento de identidad, en formato abierto o tokenizado, codificada en Base64
documentBackRawImage
Sí
Imagen del dorso del documento de identidad, en formato abierto o tokenizado, codificada en Base64. Opcional para documentos de una sola cara como PASSPORT
merchantIdScanReference
No
Referencia personalizada de la operación. Longitud máxima: 100 caracteres
documentRawImageMimeType
No
Formato mime de la imagen "image/png" o "image/jpeg"
Ejemplo de respuesta:
text
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 versiones futuras
Estado (Status)
Solicitud de estado de validación morfológica:
bash
Parámetros de la solicitud:
Campo
Obligatorio
Descripción
SCAN_REFERENCE
Sí
Número de referencia del escaneo (scan reference)
TYPE
No
Valor obsoleto. Se eliminará en versiones futuras
Ejemplo de respuesta:
text
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 (scan reference)
status
Estado de la operación. Estados posibles: PENDING (PENDIENTE), DONE (COMPLETADO), FAILED (FALLADO)
Datos (Data)
Solicitud de datos de validación morfológica:
bash
Parámetros de la solicitud:
Campo
Obligatorio
Descripción
SCAN_REFERENCE
Sí
Número de referencia del escaneo (scan reference)
TYPE
No
Valor obsoleto. Se eliminará en versiones futuras
Ejemplo de respuesta:
text
Campos de la respuesta:
Las solicitudes exitosas devuelven un código de estado HTTP 200 OK acompañado de un objeto JSON que contiene la información descrita en la siguiente tabla:
Parámetro
Tipo
Descripción
status
string
Estado del servicio: Success (Éxito) o Fail (Fallo)
verification
object
acceptanceTime
string
Marca de tiempo inicial en el formato YYYY-MMDDThh:mm:ss.SSSZ
code
int
Código de estado correspondiente. Valores posibles: Started (7001), Submitted (7002), Approved (9001), Declined (9102), Resubmission (9103), Expired/Abandoned (9104), Review (9121)
decisionTime
string
Marca de tiempo correspondiente al momento de la decisión final en el formato YYYY-MMDDThh:mm:ss.SSSZ
merchantScanReference
string
Número de referencia de la validación
ScanReference
string
Referencia interna proporcionada en el estado de inicio
status
string
Estado del proceso de validación del documento. Estados posibles: Started (Iniciado), Submitted (Enviado), Approved (Aprobado), Declined (Rechazado), Resubmission (Reenvío), Expired/Abandoned (Expirado/Abandonado), Review (Revisión)
reason
string
Descripción del motivo del rechazo del documento (estado declined). Null si el estado es approved
reasonCode
int
Código asociado al motivo del rechazo. Null si el estado es approved
Document
object
type
string
Tipo de documento. Valores posibles: PASSPORT, DRIVING_LICENSE, ID_CARD, VISA, UNSUPPORTED (NO SOPORTADO)
country
string
Código del país emisor en formato ISO 3166-1 alpha-3
number
string
Número del documento
validFrom
string
Fecha de emisión del documento
validUntil
string
Fecha de caducidad del documento
placeOfIssue
string
Lugar de emisión
firstIssue
string
Fecha de la primera emisión del documento
issueNumber
string
Número de emisión
issuedBy
string
Autoridad emisora
person
object
firstName
string
Nombre del usuario
lastName
string
Apellido del usuario
idNumber
string
Número de documento del usuario
citizenship
string
Ciudadanía
nationality
string
Nacionalidad
gender
string
Género
dateOfBirth
string
Fecha de nacimiento en el formato YYYY-MM-DD
yearOfBirth
string
Año de nacimiento YYYY
placeOfBirth
string
Lugar de nacimiento
Tabla: Códigos de Razón (Reason Code)
Código
Descripción
101
Documento físico no utilizado
102
Se sospecha de manipulación del documento
103
La persona que muestra el documento no parece coincidir con la foto del documento
105
Comportamiento sospechoso
106
Fraude conocido
108
Velocidad/abuso de usuario final duplicado
109
Velocidad/abuso de dispositivo duplicado
110
Velocidad/abuso de ID duplicado
112
Ubicación IP restringida
113
Comportamiento sospechoso - Identity Farming (Cultivo de Identidad)
120
La persona en el retrato no parece coincidir con la foto de referencia
121
Falta el ID de usuario
122
No se encontró referencia
123
No se pueden pasar las comprobaciones del registro
126
Coincidencia potencial con PEP (Persona Expuesta Políticamente)
127
Coincidencia facial con lista de bloqueados
203
Documento completo no visible
502
Múltiples partes presentes en la sesión
503
Engaño intentado
504
Engaño intentado, se utilizó la pantalla del dispositivo
505
Engaño intentado, se utilizó una impresión
507
Documento presentado alterado, referencia cruzada de datos
508
Documento presentado alterado, similitud del documento con el espécimen
509
La persona que muestra el documento no coincide con la foto del documento
510
Tipo de documento presentado no compatible
511
Documento presentado caducado
515
Engaño intentado, se utilizó la pantalla del dispositivo para la imagen facial
526
Engaño intentado, fotos transmitidas (streamed)
527
No se pueden recopilar datos de comprobante de domicilio
528
La fecha del comprobante de domicilio es demasiado antigua
530
La persona es menor de 13 años
531
La persona es menor de 14 años
532
La persona es menor de 16 años
533
La persona es menor de 18 años
534
La persona es menor de 20 años
535
La persona es menor de 21 años
536
La persona es menor de 25 años
537
No se puede realizar el recorte del retrato del documento multimedia
539
Límite de reenvío excedido
540
Puntuación de confianza baja para la sesión
541
El nombre en el documento no coincide con el nombre en los datos de inicialización de la sesión
542
No se puede validar el CPF
543
La imagen facial de referencia tiene mala calidad
544
El registro no respondió
545
Falta la imagen de referencia
546
Calidad de la imagen facial insuficiente
547
Falta el rostro
548
Engaño intentado, con falta de imagen facial de referencia
549
Validación NFC fallida
602
Tipo de documento presentado no compatible
603
Falta el vídeo
605
Falta la imagen facial
606
El rostro no es claramente visible
608
Falta el frente del documento
609
Falta el dorso del documento
614
El frente del documento no está completamente en el cuadro (frame)
615
El dorso del documento no está completamente en el cuadro (frame)
619
Los datos del documento no son visibles
620
Documento presentado caducado
621
Documento anulado o dañado
625
No se puede recopilar el apellido
626
No se pueden recopilar los nombres de pila
627
No se puede recopilar la fecha de nacimiento
628
No se puede recopilar la fecha de emisión
629
No se puede recopilar la fecha de caducidad
630
No se puede recopilar el género
631
No se puede recopilar el número de documento
632
No se puede recopilar el número personal
633
No se puede recopilar la nacionalidad
634
No se puede recopilar la dirección domiciliaria
635
Falta la imagen del documento y del rostro
636
Documento presentado no es real, se utilizó una pantalla
637
Documento presentado no es real, se utilizó una impresión
640
La persona no dio su consentimiento
641
Se detectaron múltiples rostros
642
Se cargaron múltiples documentos
643
No se puede recortar la imagen facial del frente de un documento
644
No se puede recopilar el Identificador de Ciudadano (INE)
645
Reenviar - No se puede recopilar OCR (IFE)
646
No se puede estimar la edad
647
Documento no reconocido
648
Problemas técnicos
649
No se puede recopilar información de extranjero
650
No se puede recopilar el número de proceso
651
No se puede recopilar información ocupacional
652
No se puede recopilar información del empleador
653
No se puede recopilar el tipo de permiso de residencia
654
No se puede recopilar el número de licencia de conducir
655
No se puede recopilar el nombre adicional
657
Falta la imagen del pasaporte abierto
662
No se pueden recopilar las observaciones del documento
1001
El ID de consulta debe tener entre 20 y 40 símbolos
1002
El ID de consulta debe ser un UUID V4 válido
1003
El ID de consulta debe ser único, ya ha sido utilizado.
1102
Faltan parámetros obligatorios en la solicitud.
1104
La solicitud incluye parámetros no válidos.
1201
Marca de tiempo no válida. La marca de tiempo no debe ser anterior a una hora.
1202
El formato de la marca de tiempo es incorrecto. YYYY-MM-DDTHH:MM:S+Desplazamiento de zona horaria
1203
Fecha ISO 8601 no válida. La fecha debe estar en formato YYYY-MM-DD.
1301
Las características solicitadas no son compatibles.
1302
Solo se permiten URL de retorno HTTPS.
1303
Estado no válido.
1304
No se puede transitionar al estado "$STATUS".
1308
Falta el número de identificación.
1309
La validación del SSN requiere que se proporcione el nombre (firstName + lastName) O el nombre completo (fullName) de la persona.
1310
La validación del SSN requiere que se proporcionen person.dateOfBirth o datos de dirección.
1400
No se encontraron datos de imagen.
1401
La imagen no tiene un base64 válido.
1402
El contexto de la imagen no es compatible.
1403
Falta la propiedad de la imagen.
1500
El campo vendorData no puede tener más de 1000 símbolos.
1501
vendorData debe ser una cadena.
2003
La fecha de nacimiento no es una fecha válida.
2101
El número de documento debe tener entre 6 y 9 caracteres.
2102
El número de documento solo puede contener caracteres y números A-Z, 0-9.
2103
El tipo de documento no es compatible.
2104
El documento del país proporcionado no es compatible.
Last updated