# OCR INE

Fuente: /ine-validation/frontal-ocr-ine/

El endpoint de OCR INE se encarga de extraer la información de la parte frontal del INE a
partir de una imagen del INE en formato base64.

**Método:**   POST

#### **Endpoint**

```
https://api.verificamex.com/identity/v1/ocr/obverse

```

> **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](/authentication/generate-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 |
| - | - | - |
| `ine_front` | `String` | Imágen frontal del INE codificada en base64. |

#### **Ejemplo de cuerpo de la solicitud**

```json
{
    "ine_front": "data:image/png;base64,iVBORw0KGgoAAAANS...."
}
```

### 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**

```json
{
    "data": {
        "object": "obverse_ocr_readings",
        "ocr": "GARCIA LOPEZ MARIA FERNANDA GARCIA LOPEZ MARIA FERNANDA 15/08/2030 12/04/1985 M Mexico GARLF850412HPLRLR02 GLFM85041221H050 3021 CALLE DEL SOL 1234 INT 5 COLONIA CENTRO 70000 OAXACA, OAX. OAXACA, OAX. 0002 045 01 CALLE DEL SOL 1234 INT 5 COLONIA CENTRO 70000",
        "parse_ocr": [
            {
                "type": "Surname",
                "name": "Apellido/s",
                "value": "GARCIA LOPEZ",
                "source": "OCR"
            },
            {
                "type": "FatherSurname",
                "name": "Apellido Paterno",
                "value": "GARCIA",
                "source": "OCR"
            },
            {
                "type": "MotherSurname",
                "name": "Apellido Materno",
                "value": "LOPEZ",
                "source": "OCR"
            },
            {
                "type": "Name",
                "name": "Nombre",
                "value": "MARIA FERNANDA",
                "source": "OCR"
            },
            {
                "type": "FullName",
                "name": "Nombre Completo",
                "value": "GARCIA LOPEZ MARIA FERNANDA",
                "source": "OCR"
            },
            {
                "type": "DateOfExpiry",
                "name": "Fecha de Expiración",
                "value": "15/08/2030",
                "source": "OCR"
            },
            {
                "type": "DateOfBirth",
                "name": "Fecha de Nacimiento",
                "value": "12/04/1985",
                "source": "OCR"
            },
            {
                "type": "Sex",
                "name": "Sexo",
                "value": "M",
                "source": "OCR"
            },
            {
                "type": "IssuingStateName",
                "name": "Nombre del País de Emisión",
                "value": "Mexico",
                "source": "OCR"
            },
            {
                "type": "PersonalNumber",
                "name": "Número Personal",
                "value": "GARLF850412HPLRLR02",
                "source": "OCR"
            },
            {
                "type": "Voter_Key",
                "name": "Clave de Elector",
                "value": "GLFM85041221H050",
                "source": "OCR"
            },
            {
                "type": "Section",
                "name": "Sección",
                "value": "3021",
                "source": "OCR"
            },
            {
                "type": "PermanentAddress",
                "name": "Dirección",
                "value": "CALLE DEL SOL 1234 INT 5 COLONIA CENTRO 70000 OAXACA, OAX.",
                "source": "OCR"
            },
            {
                "type": "Address_State",
                "name": "Provincia/Estado de Residencia",
                "value": "OAXACA, OAX.",
                "source": "OCR"
            },
            {
                "type": "Address_Location",
                "name": "Localidad de Residencia",
                "value": "0002",
                "source": "OCR"
            },
            {
                "type": "Address_Municipality",
                "name": "Delegación Municipio",
                "value": "045",
                "source": "OCR"
            },
            {
                "type": "NumberOfDuplicates",
                "name": "Número de duplicados",
                "value": "01",
                "source": "OCR"
            },
            {
                "type": "AddressStreet",
                "name": "Calle de Residencia",
                "value": "CALLE DEL SOL 1234 INT 5",
                "source": "OCR"
            },
            {
                "type": "AddressCity",
                "name": "Ciudad de Residencia",
                "value": "COLONIA CENTRO 70000",
                "source": "OCR"
            },
            {
                "type": "AddressStreetType",
                "name": "Tipo Vía Dirección",
                "value": "Calle",
                "source": "ExternalServices"
            },
            {
                "type": "AddressStreet",
                "name": "Calle Dirección",
                "value": "Del Sol",
                "source": "ExternalServices"
            },
            {
                "type": "AddressAdditionalInfo",
                "name": "Información Adicional",
                "value": "5",
                "source": "ExternalServices"
            },
            {
                "type": "AddressStreetNumber",
                "name": "Número de Calle Dirección",
                "value": "1234",
                "source": "ExternalServices"
            },
            {
                "type": "AddressArea",
                "name": "Área Dirección",
                "value": "Colonia Centro",
                "source": "ExternalServices"
            },
            {
                "type": "AddressCity",
                "name": "Ciudad Dirección",
                "value": "Oaxaca de Juárez",
                "source": "ExternalServices"
            },
            {
                "type": "AddressCounty",
                "name": "Provincia Dirección",
                "value": "Oaxaca",
                "source": "ExternalServices"
            },
            {
                "type": "AddressCountry",
                "name": "País Dirección",
                "value": "Mexico",
                "source": "ExternalServices"
            },
            {
                "type": "AddressCountryCode",
                "name": "Código País Dirección",
                "value": "MX",
                "source": "ExternalServices"
            },
            {
                "type": "AddressPostalCode",
                "name": "Código Postal Dirección",
                "value": "70000",
                "source": "ExternalServices"
            }
        ]
    },
    "meta": {
        "include": [],
        "custom": []
    }
}
```

**status 422**

Este error ocurre si falta algún parámetro o si el parámetro no es una cadena de caracteres.

```json
{
    "message": "El campo ine_front debe ser una cadena de caracteres. (and 1 more error)",
    "errors": {
        "ine_front": [
            "El campo ine_front debe ser una cadena de caracteres.",
            "El campo ine_front es obligatorio."
        ]
    }
}
```