Crear lectura frontal INE

El endpoint de OCR frontal INE usa la imagen de la parte frontal de una INE en formato base64 para crear una solicitud para obtener el texto estructurado del contenido de la INE.

Descripción

Una vez generada la solicitud:

• Se creara una entidad FrontId la cual después del proceso interno entrega los valores asociados a la identificación proporcionada.

Método: POST

Endpoint

https://api.verificamex.com/identity/v2/ocr/identifications/front

Nota

Recuerda que debes tener un token válido para realizar la solicitud. Puedes obtener un token siguiendo los pasos descritos en la sección Generar tokens.

Encabezados de la Solicitud

Para realizar la solicitud es necesario incluir los siguientes encabezados:

Encabezado	Valor	Descripción
Accept	application/json	Tipo de contenido de la solicitud.
Authorization	Bearer {tu_token}	Token generado para autenticar al usuario.

Consejo

Las imágenes deben ser codificadas en formato base64 para poder ser enviadas en el cuerpo de la solicitud.

Cuerpo de la Solicitud

El cuerpo de la solicitud debe contener los siguientes parámetros:

Parámetro	Tipo	Descripción
image	String	Imágen frontal del INE en formato base64.

Ejemplo de cuerpo de la solicitud

{
    "image": "{imagen_base64}"
}

Respuesta del Endpoint

Precaución

La lectura OCR depende de la calidad de la imagen, por lo que es recomendable que la imagen sea de buena calidad para obtener mejores resultados.

status 200

    {
        "data": {
            "object": "FrontId",
            "uuid": "99999999-9999-9999-9999-999999999999",
            "model": "XX",
            "data": {
                "DocumentData": [
                    {
                        "Name": "Nombre",
                        "Type": "Name",
                        "Value": "NOMBREX NOMBREY\n",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Fecha de Expiración",
                        "Type": "DateOfExpiry",
                        "Value": "31/12/2099",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Fecha de Nacimiento",
                        "Type": "DateOfBirth",
                        "Value": "01/01/1990",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Fecha de Emisión",
                        "Type": "FullDateOfIssue",
                        "Value": "2090",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Sexo",
                        "Type": "Sex",
                        "Value": "X",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Número Personal",
                        "Type": "PersonalNumber",
                        "Value": "XXXX900101XXXXXX00",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Clave de Elector",
                        "Type": "Voter_Key",
                        "Value": "XXXXX900101XX000",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Sección",
                        "Type": "Section",
                        "Value": "9999",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Dirección",
                        "Type": "PermanentAddress",
                        "Value": "CALLE FICTICIA 12345\nCIUDAD, PAÍS.",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Número de duplicados",
                        "Type": "NumberOfDuplicates",
                        "Value": "99",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Segundo Apellido",
                        "Type": "SecondSurname",
                        "Value": "APELLIDOZ\n",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Apellido Paterno",
                        "Type": "FatherSurname",
                        "Value": "APELLIDOX\n",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Apellido Materno",
                        "Type": "MotherSurname",
                        "Value": "APELLIDOY\n",
                        "Source": "OCR"
                    },
                    {
                        "Name": "Modelo de Credencial",
                        "Type": "ModelCredential",
                        "Value": "modelo_xx",
                        "Source": "OCR"
                    }
                ]
            },
            "image": "base64Binary",
            "user_id": 9999,
            "created_at": "2099-12-31T23:59:59.000000Z",
            "updated_at": "2099-12-31T23:59:59.000000Z"
        },
        "meta": {
            "include": [],
            "custom": []
        }
    }

status 422