/v1/sessions/{id}/decision/ine-registry

  • Updated on Aug 6, 2025
  • Published on Jan 30, 2025
Prev Next
Get
/v1/sessions/{id}/decision/ine-registry

Returns data about the INE identification number.

INE (Institutio Nacional Electoral - Mexican Electoral Registry) is the organization that issues the voter ID cards and maintains the voters registry.


Note: always ensure that you use the correct API URL to send requests. See the API URL section for more info.



Security
API Key: api_key
Header parameter namex-auth-client

Your integration's API key (occasionally referred to the "Token", "API public key" or "Publishable key")

Header parameters
x-hmac-signature
stringRequired

Session id signed with the shared secret key

Path parameters
id
stringRequired

Session id

Query parameters
version
stringRequired
Responses
200

Result of the ine-registry check

Headers
x-auth-client
string
Your integration's API key. Required to identify the request or response sender. Occasionally referred to as the "API token".
x-hmac-signature
string
Response body signed with the shared secret key. Required to authenticate the response sender.
vrf-auth-client
string
Your integration's API key. Required to identify the request or response sender. Same as x-auth-client.
vrf-hmac-signature
string
Response body signed with the shared secret key. Required to authenticate the response sender. Same as x-hmac-signature.
object
active
boolean

Indication of if the INE identification number is active (true) or inactive (false)

Examplefalse
documentState
string

Human readable description of the status of the query

ExampleNo se obtuvieron datos de la consulta con los parámetros seleccionados
400

Bad request

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleValidation failed
401

Unauthorized

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleMandatory X-AUTH-CLIENT header containing the API key is missing from the request.
404

Session not found

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleResource not found
500

Internal server error

object
status
string
Valid values[ "fail" ]
Examplefail
code
string
Example1101
message
string
ExampleSomething went wrong



Document Versioning

Article Versioning

Date

Description

Aug 6, 2025

Response headers added

Mar 12, 2025

Documentation published