/v1/ine/card
Sube fotos o un PDF escaneado de una credencial para votar y recibe los datos impresos en ella, un conjunto de comprobaciones de que esos datos coincidan entre sí y, si lo pides, la respuesta del propio INE sobre si la credencial está registrada y vigente y el registro de RENAPO para su CURP. Tarda 2 a 4 segundos con fotos y cuesta 10 créditos, más 10 si consultas al INE y 5 si consultas a RENAPO, que solo se cobran si responden.
Úsalo para que las personas fotografíen su credencial en vez de teclearla, y para detectar una credencial cuyo frente, reverso, CURP y clave de elector no cuentan la misma historia. Funciona con los modelos E a J, los que siguen vigentes.
Qué puede decirte y qué no
Las comprobaciones comparan datos: el frente impreso contra las líneas de lectura mecánica del reverso, los dígitos verificadores y el código QR del reverso contra sus propios números, la CURP y la clave de elector contra la fecha de nacimiento y el sexo impresos, y el año de vigencia contra la fecha de hoy. Con verify, los identificadores de la credencial se envían al servicio de Lista Nominal del INE y el registro del INE se compara con lo que imprime la credencial. Con verify_curp se hace lo mismo con RENAPO para la CURP. Esas comprobaciones contra los registros son las que una impresión cuidadosa no puede pasar.
Una foto no puede probar que el plástico sea auténtico. Los hologramas, las tintas que cambian de color y los elementos UV requieren tener la credencial en la mano, y este endpoint no los evalúa. Lee consistent: true como "los datos son coherentes", no como "la credencial es auténtica".
Un PDF te dice todavía menos sobre quién lo envía. Es una copia, y cualquiera a quien la persona se la haya mandado puede volver a subirla. El campo source de la respuesta dice cuál recibiste, para que puedas pedirle más a un PDF: verify y verify_curp para confirmar los datos con los registros, y una prueba de vida o una sesión alojada cuando necesites a la persona misma.
Solicitud
Envía multipart/form-data, como un formulario de navegador envía archivos. Este endpoint no acepta cuerpos JSON.
| Campo | Tipo | Requerido | Descripción |
|---|---|---|---|
front |
archivo | Uno de los dos | Foto o escaneo del frente de la credencial: JPEG, PNG, WebP o PDF. Da los datos impresos y si la credencial tiene retrato. Se necesita para verify_curp. |
back |
archivo | Uno de los dos | Foto o escaneo del reverso: JPEG, PNG, WebP o PDF. Da el CIC y el identificador del ciudadano a partir de las líneas de lectura mecánica, y el código QR. Se necesita para verify y para las comprobaciones de frente contra reverso. |
verify |
boolean | No | Envía true para consultar además al INE sobre la credencial, como lo hace /v1/ine/verify. Agrega 4 a 15 segundos y 10 créditos, que solo se cobran cuando el INE responde. |
verify_curp |
boolean | No | Envía true para consultar también a RENAPO sobre la CURP impresa en el frente, como lo hace /v1/curp/lookup. Agrega unos 2 segundos y 5 créditos, que solo se cobran cuando RENAPO responde. Una CURP que no pasa su propio dígito verificador no se envía. |
webhook_url |
string | No | Cuando se envía, el API responde 202 de inmediato y hace POST del resultado a esta URL en cuanto está listo. Solo http o https. No se siguen redirecciones. Máximo 2048 caracteres. |
Envía ambos lados cuando puedas: la mayoría de las comprobaciones necesita los dos. Las fotos deben estar enfocadas y mostrar la credencial completa; una tomada de lado o de cabeza también se lee. Las fotos HEIC no se leen; conviértelas a JPEG primero. Los archivos pueden sumar hasta 50 MB.
También se lee un PDF escaneado, en las formas en que la gente lo arma: ambos lados en una página, un lado por página en cualquier orden, o un archivo por lado. Cada lado se busca en todas las páginas, así que un solo PDF con ambos lados puede ir en cualquiera de los dos campos. El PDF de una credencial tiene una o dos páginas; uno más largo se rechaza. Leer un PDF tarda 3 a 5 segundos.
Solicitud de ejemplo
curl -X POST https://inecheck.com/v1/ine/card \
-H "x-api-key: rfc_your_api_key" \
-F [email protected] \
-F [email protected] \
-F verify=true \
-F verify_curp=true
Respuesta (200)
El ejemplo usa datos de muestra, basados en la credencial espécimen publicada por el INE, leídos sin verify ni verify_curp. Con verify, ine trae el mismo cuerpo que devuelve /v1/ine/verify; con verify_curp, renapo trae el cuerpo que devuelve /v1/curp/lookup.
{
"read": true,
"source": "photo",
"consistent": true,
"message": "The credential was read and its data agrees.",
"credential": {
"nombre": "GOMEZ VELAZQUEZ MARGARITA",
"domicilio": "VIADUCTO TLALPAN NO. 100 COL. ARENAL TEPEPAN, ALCALDIA TLALPAN. C.P. 14610, CIUDAD DE MEXICO.",
"clave_elector": "GMVLMR80070501M100",
"curp": "GOVM800705MDFMLR06",
"fecha_nacimiento": "1980-07-05",
"sexo": "M",
"seccion": "0001",
"anio_registro": 2008,
"numero_emision": "01",
"anio_emision": 2019,
"vigencia": 2029,
"cic": "183657717",
"ocr": "0001011111110",
"id_ciudadano": "011111110"
},
"checks": {
"name_matches_back": true,
"birth_date_matches_back": true,
"sex_matches_back": true,
"vigencia_matches_back": true,
"seccion_matches_back": true,
"emision_matches_back": true,
"mrz_check_digits": true,
"qr_matches_back": true,
"curp_check_digit": true,
"curp_matches_data": true,
"clave_elector_matches_data": true,
"not_expired": true,
"registered_with_ine": null,
"ine_record_matches_card": null,
"registered_with_renapo": null,
"renapo_record_matches_card": null
},
"photo": true,
"mrz": [
"IDMEX1836577177<<0001011111110",
"8007050M2912316MEX<01<<12345<0",
"GOMEZ<VELAZQUEZ<<MARGARITA<<<<"
],
"qr": "http://qr.ine.mx/000101111111001183657717/20191216/P/003660",
"ine": null,
"renapo": null
}
read es true (las fotos dieron datos de la credencial), false (nada en ellas se pudo leer como credencial: muy borrosa, recortada o no es una credencial) o null (el lector no estaba disponible, reintenta más tarde). Solo se cobra read: true.
Cómo leer la respuesta
-
credential: lo que dicen las fotos. Los campos impresos vienen del frente; cic, ocr e id_ciudadano vienen del reverso. Un campo que las fotos no dieron es null. Cuando las letras del nombre coinciden con el reverso, nombre toma del reverso la separación entre palabras, porque ahí cada palabra va separada. -
checks: cada comprobación es true, false o null cuando las fotos no dieron los dos lados de la comparación. -
source: photo o pdf: lo que se subió. Un PDF es una copia que cualquiera que la haya recibido puede volver a subir, así que dice menos que una foto sobre quién tiene la credencial. Para los PDF, apóyate en verify y verify_curp. -
consistent: false cuando alguna comprobación falló, true cuando al menos una se ejecutó y ninguna falló, null cuando ninguna se pudo ejecutar. Una comprobación fallida también puede ser un carácter mal leído en una foto de mala calidad, así que pide otra toma antes de rechazar a alguien. -
photo: si se encontró un rostro en el frente. null cuando no se envió el frente. -
mrz: las tres líneas de lectura mecánica del reverso, tal como se leyeron. -
qr: la dirección del código QR pequeño de servicios en el reverso. Los dos códigos QR densos están cifrados para la app del propio INE y no se decodifican. -
ine: La respuesta del INE cuando se envió verify y el reverso dio los identificadores; si no, null. Si no se pudo consultar al INE, ine.found es null y solo se cobran los 10 créditos de la lectura. -
renapo: la respuesta de RENAPO cuando se envió verify_curp y el frente dio una CURP con dígito verificador válido; de lo contrario, null. Si no se pudo consultar a RENAPO, renapo.found es null y esa consulta no se cobra.
Las comprobaciones
| Consulta | Se cumple cuando |
|---|---|
name_matches_back |
el nombre impreso en el frente es el nombre de la tercera línea del reverso. |
birth_date_matches_back |
la fecha de nacimiento del frente es la de la segunda línea del reverso. |
sex_matches_back |
el sexo del frente (H o M) es el del reverso. No se evalúa cuando el frente imprime un género autopercibido (X, NB). |
vigencia_matches_back |
el año de vigencia del frente es el del reverso. |
seccion_matches_back |
la sección electoral impresa en el frente son los primeros cuatro dígitos del número OCR del reverso. |
emision_matches_back |
el número de emisión del frente es el de la segunda línea del reverso. |
mrz_check_digits |
los cuatro dígitos verificadores del reverso (ICAO 9303) son correctos: después del CIC, después de cada fecha y sobre ambas líneas. |
qr_matches_back |
la dirección del código QR de servicios se forma con el número OCR, el número de emisión y el CIC del reverso. |
curp_check_digit |
el último dígito de la CURP es el que producen sus otros 17 caracteres. |
curp_matches_data |
la fecha de nacimiento y el sexo dentro de la CURP son los impresos. |
clave_elector_matches_data |
la fecha de nacimiento y el sexo dentro de la clave de elector son los impresos. |
not_expired |
el año de vigencia es este año o uno posterior. Una credencial es válida hasta el 31 de diciembre. |
registered_with_ine |
con verify: el INE tiene un registro para los identificadores de la credencial y no lo reporta como no vigente. |
ine_record_matches_card |
con verify: la clave de elector, el año de registro, el número de emisión y la vigencia que el INE tiene registrados son los impresos en la credencial. |
registered_with_renapo |
con verify_curp: RENAPO tiene un registro para la CURP de la credencial. |
renapo_record_matches_card |
con verify_curp: el nombre completo, la fecha de nacimiento y el sexo que RENAPO tiene para esa CURP son los impresos en la credencial. |
Privacidad
Las fotos se leen en memoria en nuestros propios servidores y se eliminan al terminar la solicitud. No se guarda nada y ningún tercero las recibe. Con verify, solo el CIC y el identificador del ciudadano se envían al INE; con verify_curp, solo la CURP se envía a RENAPO. Recabar el consentimiento de la persona para tratar su credencial es tu responsabilidad.
Modo webhook
Envía webhook_url como un campo más del formulario y el API responde 202 de inmediato; después hace POST del resultado a tu URL cuando termina la lectura. Es más útil con verify, cuando la consulta al INE tarda 4 a 15 segundos. Consulta Webhooks para conocer la semántica de entrega.
curl -X POST https://inecheck.com/v1/ine/card \
-H "x-api-key: rfc_your_api_key" \
-F [email protected] \
-F [email protected] \
-F verify=true \
-F webhook_url=https://example.com/webhooks/ine-card
{
"status": "processing",
"message": "Card reading in progress"
}
{
"status": 200,
"body": {
"read": true,
"consistent": true,
"...": "the same body the endpoint returns without webhook_url"
}
}
En modo webhook la solicitud se cobra cuando se acepta, incluyendo cada consulta que pediste (verify, verify_curp), responda o no ese registro. Se reembolsa por completo cuando el resultado es uno que la llamada directa no habría cobrado: read false o null, o una solicitud que no se pudo usar.
Captura alojada
¿Quieres que nosotros alojemos la captura? Una sesión de verificación te da una liga donde la persona fotografía ambos lados con la cámara en vivo de su teléfono y luego graba el video de prueba de vida, y devuelve la respuesta de este endpoint dentro de su resultado.
Errores
-
422 invalid_fields: fields indica qué corregir: no se envió ni front ni back, o alguno se envió como texto en vez de archivo. No se cobra. -
422 unreadable_image: un archivo no se pudo abrir como imagen ni como PDF (HEIC, un PDF protegido con contraseña, una carga incompleta). No se cobra. -
422 too_many_pages: un PDF tiene más de 2 páginas, así que no es una credencial para votar. No se cobra. -
422 invalid_webhook_url: webhook_url no es una dirección a la que podamos llamar: no es http ni https, es demasiado larga o resuelve a una red privada. No se lee nada. No se cobra.