INE validation service
INE service V5
The service performs identification, classification, and validation of voter identification cards issued by the Instituto Nacional Electoral (INE) verifying the authenticity and reliability of the data by querying directly official sources of INE and the Registro Nacional de Población (RENAPO).
This version is similar to INE V4. It improves performance and responsiveness, with some adjustments to the amount of data displayed, particularly in the CURP section.
Rest Web service description
The service offers two ways to verify the authenticity of official documents.
1.- Identification and classification The first is the identification and classification, the pre-processing parameters checkQuality, checkPatterns, checkFace are used to add the results of the physical and quality controls in the validation equation of the document. These parameters do not change the function of the service, as "identification and classification" is done to determine OCR processing and metadata retrieval.
Parameters to send: checkQuality (default true), checkPatterns (default true), checkFace (optional).
2.- Validation The second is the validation phase, the post-processing or "metadata validation" modify the execution of the service.
Parameters to send: checkInfo (by default true and optional), checkCurp (by default true and optional).
And finally, debugRenapo (not considered for the validation process).
~/api/Business/ine
Versions
- Version 5 (5.0)
- Supports voter ID types D, E, F, G and H. ( INE Samples )
- Verify INE data through the INE Nominal List. This version get the messages without any change, that means the message is exactly as the returned by the original INE source.
- Verify CURP through RENAPO. This version obtain only basic Curp data.
- Ine Nominal List section/node incorporates the TAG1,TAG2,TAG3 fields, corresponding to the Ine Nominal List supplementary info.
Parameters
| Tag | Type | Required | Description |
|---|---|---|---|
| checkInfo | boolean | yes | Data verification. Default value: true. |
| checkQuality | boolean | yes | Quality verification on front and back documents. Default value: true. |
| checkPatterns | boolean | yes | Patters verification to validate authenticity of documents. Default value: true. |
| checkCurp | boolean | yes | CURP verification in RENAPO database. Default value: true. |
| checkFace | boolean | no | Face of the person in the mexican ID. Default value: true. |
| debugRenapo | boolean | no | Flag to send the same error as RENAPO was unavailable. Default value: false. |
| v | string | yes | Service version, must be 5.0 |
| FrontFile | file | yes | Image file of the front side of INE. |
| BackFile | file | yes | Image file of the back side of INE. |
- Note 1: File's weight max is 5 MB. The minimum 1MB.
- Note 2: File formats allowed are (JPG), (PNG) and (JPEG).
- Note 3: The maximum size allowed 4992px (width max) x 3328px (height max).
- Note 4: Image with focus.
- Note 5: Cropped INE image without excess of background is required.
- Note 6: Vertical orientation.
Required characteristics for images (front and back).
| Characteristic | Description |
|---|---|
| Focused | The images must be focused and show readable information for the correct execution of the OCR process. |
| Brightness | The images must not show glare, brightness or contrast alterations that cause error in the validation of authenticity. |
| Quality | The documents must have legibility characteristics, not be modified, not present physical damage or alteration. |
| Figure | The image should preferably be in the shape of a rectangle, where only the credential is shown without excessive background. Likewise, for both sides of the document. |
| Accepted types | The credential have to be types D, E, F, G or H. |
Headers
| Tag | Type | Required | Description |
|---|---|---|---|
| ApiKey | string | yes | Customer key. |
| x-Version | string | no | Service version, must be 5.0. |
Url Parameters
{
"checkInfo": boolean,
"checkQuality": boolean,
"checkPatterns": boolean,
"checkCurp": boolean,
"checkFace": boolean,
"debugRenapo": boolean,
"v": string
}
FormData
{
"FrontFile": file,
"BackFile": file
}
Response:
Correct:
| Name | Type | Description |
|---|---|---|
| Valid | boolean | The result of verifications. |
| type | string | Result of the type identified for the different documents like TypeDEF or TypeGH. |
| Validations | ||
| info | boolean | Result of INE validations process. |
| quality | boolean | Quality check for INE Image. Cannot have glare and it must be on focus. |
| curp | boolean | Result of CURP verification in RENAPO database. |
| patternCheck | boolean | Result of INE pattern check. |
| face | boolean | Result of face check. |
| nominalListCheck | boolean | Result of Ine verification in Nominal List. |
| Front | ||
| focus | boolean | Checks if the front image it is in focus. |
| glare | boolean | Checks if the front image does not have glare. |
| Back | ||
| focus | boolean | Checks if the back image it is in focus. |
| glare | boolean | Checks if the back image does not have glare. |
| Data | ||
| name | string | Name. |
| firstlastname | string | First Surname. |
| secondlastname | string | Second Surname. |
| addressline | string | Address Line one. |
| addressline2 | string | Address Line two. |
| addressline3 | string | Address Line tree. |
| electoralId | string | Voter ID. |
| curp | string | Clave Única de Registro de Población. |
| dateOfbirth | string | Date of birth. (DD/MM/YYYY) |
| sex | string | Gender. (H: Hombre -M:Mujer -X:No Binario) |
| folio | string | Identifier for the IDs type C located on the front. Type C credential, obsolete format that can no longer vote. |
| issueNumber | string | Issue number. |
| idNumber | string | Id number for the IDs type C located on the back. Type C credential, obsolete format that can no longer vote. |
| idmex | string | Id number for the IDs type DEF located on the back. |
| mz1 | string | First line of values in the back of the id. Does not apply to type C. Type C, obsolete format that can no longer vote. |
| mz2 | string | Second line of values in the back of the id. Does not apply to type C. Type C credential, obsolete format that can no longer vote. |
| mz3 | string | Third line of values in the back of the id. Does not apply to type C.Type C credential, obsolete format that can no longer vote. |
| expirationDate | string | Expiration Date of the document. |
| CURP Simple Data from RENAPO | ||
| curp | string | Clave Única de Registro de Población. |
| dateofbirth | string | Date of birth. (DD/MM/YYYY) |
| names | string | Name. |
| lastname | string | First Surname. |
| secondlastname | string | Second Surname. |
| sex | string | Gender. (H: Hombre -M:Mujer -X:No Binario) |
| nationality | string | Nationality. |
| entity | string | Entity of birth. See Federal Entities Table for possible values. |
| probationaryDocument | string | Probationary Document. |
| statusCurp | string | Status of CURP. See StatusCurp List Code and description for possible values. |
| Nominal List Data from INE | ||
| canVote | boolean | Identification can be used to vote. |
| type | string | Identification type. |
| electorCode | string | Electoral code. |
| cicNumber | string | Credential Identification Code. |
| issueNumber | string | Issue number. |
| issueYear | string | Issue year. |
| registrationYear | string | Year of registry. |
| ocrNumber | string | Optical Character Recognition Code. |
| expDate | string | Expiration date. (YYYY-MM-DD) |
| tag1 | string | First supplementary information, relating to verify a voter ID, as provided in the Nominal List. |
| tag2 | string | Second supplementary information, relating to validity, as provided in the Nominal List. |
| tag3 | string | Third supplementary information, relating to notifications, as provided in the Nominal List. |
| warnings | array | Error messages. |
JSON file
{
"valid": boolean,
"type": "string",
"validations": {
"info": boolean,
"quality": boolean,
"curp": boolean,
"patterns": boolean,
"face": boolean,
"nominalListCheck": boolean
},
"front": {
"focus": boolean,
"glare": boolean
},
"back": {
"focus": boolean,
"glare": boolean
},
"data": {
"name": "string",
"firstLastName": "string",
"secondLastName": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"electoralId": "string",
"curp": "string",
"dateOfBirth": "string",
"sex": "string",
"folio": "string",
"idNumber": "string",
"idMex": "string",
"mz1": "string",
"mz2": "string",
"mz3": "string",
"expirationDate": "string"
},
"curpData": {
"curp": "string",
"dateofbirth": "string",
"names": "string",
"lastname": "string",
"secondlastname": "string",
"sex": "string",
"nationality": "string",
"entity": "string",
"probationaryDocument": "string",
"statusCurp": "string"
},
"nominalListData": {
"canVote": true,
"type": "string",
"electorCode": "string",
"cicNumber": "string",
"issueNumber": "string",
"issueYear": "string",
"registrationYear": "string",
"ocrNumber": "string",
"expDate": "string",
"tag1":"string",
"tag2":"string",
"tag3":"string",
},
"warnings": [{
"code": "string",
"message": "string"
}]
}
Error:
| Name | Type | Description |
|---|---|---|
| code | string | Error code. |
| message | string | Error message. |
| fullMessage | string | Full message means join the code of client and error message. |
{
"code": "string",
"message": "string"
"fullMessage": "string"
}
Service messages
| Code | Message | Description | HTTP Code |
|---|---|---|---|
| 00 | Success | Indicates whether the request was successful. If everything goes well, the structure of the data will be displayed. | 200 |
| Errors | |||
| INE001 | Incorrect params. There is no backFile or frontFile. | Message that is displayed when the request has been completed successfully but its response has no content, (Example: when the front and back image is not sent). | 400 |
| INE002 | Incorrect information. There is not frontFile. | Message that is displayed when the front image is not sent. | 400 |
| INE003 | Incorrect information. There is not backFile. | Message that is displayed when the back image is not sent. | 400 |
| INE004 | The format of the input document does not correspond to any of the allowed JPG, JPEG and PNG | Message that is displayed when the back or front file is not an image format file. | 415 |
| INE005 | INE / IFE document was not detected in ineFront or ineBack images. | Message displayed when the image does not correspond to a correct INE or IFE. | 422 |
| INE006 | The file size is not within the approximate range of 5 MB allowed. | Message displayed when the file is larger than the allowed. | 413 |
| INE008 | Something was wrong, we are working on the failure. | Message displayed when there is an error on the server. | 500 |
| INE009 | Access Denied. ApiKey not present. | Message displayed when a request is received with an unauthorized ApiKey. | 401 |
| INE010 | Unable to identify INE type. | Message displayed when the image cannot be classificated. | 422 |
| INE011 | We detect two images of the same side. | Message displayed when the two images received are the same side of the document. This could be two front or two back. | 400 |
| INE012 | Front image type: {Type} not supported. | Message displayed when the front side of the document corresponds to a document type that is not supported because is expired. Example: Document type B. | 415 |
| INE013 | Back image type: {Type} not supported. | Message displayed when the back side of the document corresponds to a type of document that is not supported because is expired. Example: Document type B. | 415 |
| INE016 | The data obtained from the front and back of the INE is Non-coherent information | Message appears when discrepancies are detected between the personal details shown on the front and those on the reverse side, -name, date of birth, electoral ID, or address. | 422 |
| INE017 | There is some issues processing the request. Please try again later | Message displayed when the service is temporarily overloaded. Please try again later. | 503 |
| Warnings | |||
| INE100 | Glare detected on front image | Message displayed when glare detected in the front image. | 200 |
| INE101 | Glare detected on back image | Message displayed when glare detected in the back image. | 200 |
| INE102 | Front image without focus | Message displayed when blur detected in the front image. | 200 |
| INE103 | Back image without focus | Message displayed when blur detected in the back image. | 200 |
| INE104 | Inconsistent data found on INE. | Message displayed when inconsistency was found in the data obtained from the INE. | 422 |
| INE105 | The ineFront: {0} format does not match the ineBack: {1} format. | Message displayed when the INE type don't match between the two images. | 422 |
| INE106 | Person not detected in ineFront. | Message displayed when the face is not detected in ineFront. | 203 |
| INE107 | CURP was not found in RENAPO. | Message displayed when CURP was not found in RENAPO. | 203 |
| INE108 | CURP validation was not performed with RENAPO. | Message displayed when RENAPO service was not available. | 203 |
| INE111 | The RENAPO service was not available. | Message displayed when CURP service of RENAPO was not available. | 203 |
| INE112 | The Electoral Id was not found. | Message displayed when the Electoral Id couldn't be read. | 203 |
| INE118 | Inconsistent RENAPO CURP data with INE CURP. | The INE CURP data does not match the data obtained from RENAPO CURP. | 422 |
| INE119 | INE Type A, B and C are deprecated. | The INE type A,B y C were depreced as oficial identification since 2018. | 400 |
| INE120 | The Gender field not present in the front. | Gender information may have been withheld at the voter's request. | 200 |
| INE121 | The front side and back side of the ID card are attributed to different individuals. | The front and back files might be for different people. The personal data contain some discrepancies. | 422 |
| INE122 | The card has inconsistent data with Nominal List. | There may be discrepancies between the Electoral Code card and the Nominal List. | 422 |
| INE131 | It was not possible to process the CURP, we are working on the error. | Message displayed when an error occurs processing the CURP. | 203 |
| INENL011 | La credencial no es válida para votar | Message displayed when the credential is not valid for voting purposes. | 203 |
| INENL013 | The service is under maintenance by the INE nominal list entity | Message displayed when the INE Nominal List is unavailable. | 203 |
| INENL017 | Invalid MRZ | Message displayed when the data in the Machine-Readable Zone (MRZ) is illegible. | 203 |
Incorrect or non-existent data messages
| Code | Message | Description | HTTP code |
|---|---|---|---|
| INENL001 | No se pueden validar los datos con la fuente | Message displayed when the data included in the INE was not verified in the official source. | 203 |
| INENL005 | Formato de identificación no válido | Message display when the field id of the back is invalid. | 203 |
| INENL006 | Formato OCR no válido | Message display when the field ocr of the back is invalid. | 203 |
| INENL020 | 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. | 203 |
No Valid as Official Identification messages
| Code | Message | Description | HTTP code |
|---|---|---|---|
| INENL050 | No está vigente como medio de identificación | Message displayed when the credential is not valid as Official Identification. | 203 |