INE nominal list service V4

This service allows us to validate a voter ID registry in INE database. Also if the document can be used as official identification and if it is valid to vote.

The service receives information based on the type of identification to be validated as type C, D, EF and GH.

This service version return the messages as the Nominal List, (spanish language)

Web service description

Validate INE ID into public database

This method performs the verification of the INE document and get the information of the INE nominal list.

~/api/IneNominalList

Request Parameters

Tag	Type	Required	Description
type	string	yes	Type C, D, E, F, G, or H.
id	string	yes	The method receive CIC for types D, E, F, G and H. The method receive the elector code for type C.
ocr	string	yes	The method receive OCR for type C. The method receive and citizen identifier for type types E, F, G and H.
issueNumber	string	Only in type C	It can be sent null or empty when type is different to C.

Query

Tag	Type	Required	Description
timeout	int	No	Maximum time in milliseconds waiting for the service response [between 1000-30000]

Headers

Tag	Type	Required	Description
apikey	string	Yes	Customer key
Content-Type	string	No	application/json

FormBody

{
  "type": "string", // One of C|D|E|F|G|H
  "id": "string", // CIC or Elector code
  "ocr": "string", // OCR
  "issueNumber": "string" // Only for type C can be null or empty.
}

Examples

Type C ID Model C

{
  "type": "C",
  "id": "TSVREL72100209M100",
  "ocr": "3854006556540",
  "issueNumber": "03"
}

Type D ID Model D

{
  "type": "D",
  "id": "115568150",
  "ocr": "4855115346145",
  "issueNumber": ""
}

Type E ID Model EG

{
  "type": "E",
  "id": "145591720",
  "ocr": "0535000172485",
  "issueNumber": ""
}

Type G

{
  "type": "G",
  "id": "204978519",
  "ocr": "092333274",
  "issueNumber": ""
}

Response:

The service responds by means of a JSON file with the following information:

Success

Name	Type	Description
valid	true	If the document is valid or not as official identification.
canVote	true	If the document can be used to vote or not.
type	string	Document type
electorCode	string	Elector code
cicNumber	string	CIC number
issueNumber	string	Issue number
issueYear	string	Issue year
registrationYear	string	Registration year
ocrNumber	string	OCR
expDate	string	Effective date

Error structure

Name	Type	Description
code	string	Error code
message	string	Error message

JSON

{
  "valid": true, // Valid as identification
  "canVote": true, // Can vote
  "data": {
    "type": "string", // Document type
    "electorCode": "string", // Elector code
    "cicNumber": "string", // CIC number
    "issueNumber": "string", // issue number
    "issueYear": "string", // Issue year
    "registrationYear": "string", // Registration year
    "ocrNumber": "string", // OCR
    "expDate": "string" // Effective date
  }
  "warnings": [] // List of warning messages
}

Error model

{
  "error": "string", // Error code
  "message": "string" // Error message
}

Warnings general messages

Code	Message	Description
INENL001	No se pueden validar los datos con la fuente.	Mensaje que se muestra cuando no se pueden consultar los servidores del INE.
INENL002	Algo esta mal, estamos trabajando en el fallo.	Mensaje que se muestra cuando hay un error en el servidor.
INENL003	Acceso denegado. No se encontró el encabezado de ApiKey.	Mensaje que se mostrará cuando el usuario ingrese una clave apikey incorrecta o cuando la clave apikey no se muestre.
INENL004	Formato de número de emisión no válido.	Mensaje que se muestra cuando el campo "issueNumber" no es numérico y tiene una longitud distinta a 2 caracteres.
INENL005	Formato de identificación no válido.	Mensaje que se muestra cuando el campo "Id" no es numérico y tiene una longitud distinta de 9 o 18.
INENL006	Formato OCR no válido.	Mensaje que se muestra cuando el campo "ocr" no es numérico y tiene una longitud distinta a 9 o 13
INENL007	Tipo no válido.	Mensaje que se muestra cuando el campo "tipo" no tiene un valor de "C", "D", "E", "F", "G" o "H".
INENL008	No se pueden validar los datos.	Mensaje que se muestra cuando se excede el tiempo de espera para la validación con respecto a la fuente.
INENL011	La credencial no es válida para votar.	Mensaje que se muestra cuando la credencial no se puede utilizar para votar.
INENL012	El tiempo de espera está fuera de rango; debe estar entre 1000 y 30000.	Mensaje que se muestra cuando el tiempo de espera está fuera de rango.
INENL013	El servicio está en mantenimiento por parte de la entidad de listado nominal del INE.	Mensaje mostrado cuando no se pudo realizar la validación.
INENL015	Acceso denegado, la empresa no pudo ser identificada.	Mensaje mostrado cuando el apikey de la empresa es inválida
INENL016	El registro no pudo ser encontrado	Mensaje mostrado cuando los datos proporcionados no arrojan ningún valor coincidente.

Incorrect or non-existent data messages

Code	Message	Description
INENL020 (INENL009)	No se obtuvieron datos de la consulta con los parámetros seleccionados	Message displayed when no information related to the entered data was found in the INE source.
INENL021	No se obtuvieron datos de la consulta con los parámetros seleccionados, verifica que no tienes un trámite posterior	Message displayed when exist a new INE by transact or no information related to the data entered in the INE source has been found.

Valid as Official Identification messages

Code	Message	Description
INENL030	Está vigente como medio de identificación	Message displayed when the credential is valid as Official Identification
INENL031	Está vigente como medio de identificación, Tu domicilio dejó de pertenecer a la Sección Electoral	Message displayed when the credential is valid as Official Identification, but it must be renewed, due to changes in the Electoral Section.
INENL040	Esta vigente como medio de identificación y puedes votar	Message displayed when the credential is valid as Official Identification and valid to voting.

No Valid as Official Identification messages

Code	Message	Description
INENL050 (INENL010)	No está vigente como medio de identificación	Message displayed when the credential is not valid as Official Identification
INENL051	No está vigente como medio de identificación, ¡Tú credencial fue dada de baja por pérdida de vigencia!	Message displayed when the credential was canceled due to loss of validity
INENL052 (INENL014)	No está vigente como medio de identificación, ¡Esta no es tu última credencial!, realizaste un trámite de actualización de datos	Message displayed when this is not the latest voter ID issued, check the current IFE/INE