The INE webhook passes back data after the check in the Mexican Electoral Registry (Instituto National Electoral) has been completed. The payload is sent to Webhook INE registry URL
, which you need to set up in the Veriff Customer Portal.
→ See Webhooks Guide > Set up webhooks sub-section for detailed overview of the setup process
When is INE webhook sent?
The INE webhook is sent after the verification session is done and after the registry checks have been completed.
Prerequisites
- Make sure you have access to the Veriff Customer Portal
- Set up webhook URL(s) on your side and have them at hand
- Make sure they match the Webhook URL requirements
- Make sure your system is able to handle Webhooks receipt, delivery and resending requirements
- Secure your communication, check the HMAC Authentication and Endpoint Security article
- Make sure your system is able to handle the Backwards compatible changes
Proceed to INE webhook setup below
INE webhook setup
Log in to the Veriff Customer Portal
Navigate to the Integrations page via the top menu and open the relevant integration used for the registry check
On the integration's page, select the Settings tab
Under the title Integration settings you see a list of webhooks
Fill in the
Webhook INE registry URL
→ See Webhooks Guide > Set up webhooks sub-section for detailed overview of the setup process
Sample request
{
"eventType": "ine_registry",
"sessionId": "f04bdb47-d3be-4b28-b028-a652feb060b5",
"attemptId": "e30122d1-740b-4764-853f-470374a7abf4",
"vendorData": "1234567812345678",
"endUserId": "a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4",
"version": "1.0.0",
"time": "2021-06-02T11:04:00.287Z",
"data": {
"status": "La credencial es válida",
"code": 200,
"details": {
"active": true,
"documentState": "El documento es válido."
}
}
}
Request properties explained
*Required field
eventType
:string
* INE registry event name, returns:ine_registry
sessionId
:string
* UUID for the session where this check was executedattemptId
:string
* UUID v4 which identifies session attemptvendorData
:string | null
* The unique identifier that you created for your end-user.null
if not specifiedendUserId
:string | null
* TheUUID
that you created for your end-user.null
if not specifiedversion
:string
* Version number of the checktime
:string
* Timestamp of sending the webhook, represented asUTC YYYY-MM-DDTHH:MM:S+Timezone Offset
(ISO 8601)data
:object
* Array of data objectsstatus
:string
Status of the datacode
:number
An integer number of the HTTP status code. See the Common HTTP status codes table for more infodetails
:object
Details connected to the specific check against the registryactive
:boolean
Indication of if the INE identification number is active (true
) or inactive (false
)documentState
:string
Explanation of thedata.status
value