ID Reader Plus

POST

  https://api.apptenticate.com/api/v3/ocr/

Autenticación

Usa tu JWT obtenido del proceso de autenticación para hacer peticiones a este endpoint.

La respuesta sera 401 unauthorized si el JWT se encuentra vencido. En dicho caso deberás obtener un nuevo JWT.

---

Este endpoint recibe todas las peticiones dirigidas al microservicio de OCR de Apptenticate que permite extraer datos de documentos de identificación.

Si se tiene contratado este servicio se realiza una verificación de Prueba de Vida del documento para verificar la validez del documento. Este servicio verifica la veracidad de la imagen para detectar ataques como documentos que no se poseen físicamente o manipulación de un documento que de otro modo sería auténtico, documentos presentados como copia impresa, sustitución de rostro o documentos en otra pantalla.

Al final, el microservicio de ID Reader retornará un JSON con los datos extraídos si la operación fue exitosa, o el debido error si no pasa la verificación de prueba de vida.

NOTA

• La respuesta puede ser 401 unauthorized si el token JWT debe ser refrescado.
• Las imágenes enviadas en formato jpg no debe exceder los 2MB.
• Si se desea obtener en la respuesta el ID de la transacción, se debe indicar "return_id": "True" en el JSON de la request.
• Se debe especificar en la request si se envía foto de un pasaporte o una cédula mediante el parámetro “document_type”, que puede tomar los valores “passport” o “identification_card”.

Estructura de requests - método: POST

El payload enviado es igual al de Cédulas y Pasaportes

Ruta: api/ocr/

• Payload para request base:

Payload: {
    'frontside': Imagen del frente del documento,
    'document_type': 'passport',
    'document_id': Código del pasaporte // opcional si se quiere obtener el OCR de un pasaporte que esté soportado en la biblioteca
} // (donde las imágenes son archivos .jpg)

• Payload para request base cedúlas:

Payload: {
    'frontside': Imagen del frente del documento,
    'backside': Imagen del dorso del documento,
    'document_type': 'identification_card',
} // (donde las imágenes son archivos .jpg)

• Si se desea obtener el ID de la transacción:

Payload: {
    'frontside': Imagen del frente del documento,
    'document_type': 'passport',
    'return_id':True
    'document_id': Código del pasaporte // opcional si se quiere obtener el OCR de un pasaporte que esté soportado en la biblioteca
} // (donde las imágenes son archivos .jpg)

• Si se desea mejorar la precisión de la prueba de vida

Payload: {
    'frontside': Imagen del frente del documento,
    'document_type': 'passport',
    'device':'IOS', // Dispositivos: IOS, ANDROID o DESKTOP
    'document_id': Código del pasaporte // opcional si se quiere obtener el OCR de un pasaporte que esté soportado en la biblioteca
} // (donde las imágenes son archivos .jpg)

Ejemplos de respuestas

Respuestas de documentos que no pasan la prueba de vida

Ruta: api/ocr/

{
    "valid": false,
    "error_code": 820,
    "error": "La foto del documento no se detecta en la imagen.",
    "id": 391
},

{
    "valid": false,
    "error_code": 821,
    "error": "El documento esta recortado, parte del documento no esta presente en la imagen.",
    "id": 392
},

{
    "valid": false,
    "error_code": 819,
    "error": "El documento no se detecta en la imagen.",
    "id": 393
}

Códigos de error:

Codigo	Mensaje
818	Calidad de imagen para prueba de vida de documento no aceptable.
819	El documento no se detecta en la imagen.
820	La foto del documento no se detecta en la imagen.
821	El documento está recortado, parte del documento no está presente en la imagen.
822	El tamaño del documento es inferior al 10 % del tamaño de la imagen.
823	Los bordes del documento están fuera de la imagen.
824	Hay más de un documento presente en el marco.
825	El documento está demasiado cerca.
826	La imagen está demasiado borrosa.
827	La imagen está demasiado comprimida.
828	La imagen es demasiado brillante u oscura.
829	La imagen tiene reflejos.