The CURP webhook passes back data after the check in the Mexican Population Registry (Clave Única de Registro de Población) has been completed. The payload is sent to Webhook CURP 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 CURP webhook sent?
The CURP 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
5.Proceed to CURP webhook setup
CURP webhook setup
Log in to the Veriff Customer Portal
Navigate to the Integrations page via the top menu and open the 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 CURP registry URL
→ See Webhooks Guide > Set up webhooks sub-section for detailed overview of the setup process
Sample request
{
"type": "curp_registry",
"id": "f04bdb47-d3be-4b28-b028-a652feb060b5",
"vendorData": "1234567812345678",
"endUserId": "a1b2c35d-e8f7-6d5e-3cd2-a1b2c35db3d4",
"version": "1.0.0",
"data": {
"attemptId": "e30122d1-740b-4764-853f-470374a7abf4",
"name": "curp_registry",
"status": "found",
"code": 200,
"details": {
"statusCurp": "RCN",
"curp": "VISH760905HSRLNN06",
"description": "Registro de cambio no afectando a curp"
}
}
}
Full forms of the CURP data status acronyms
The field statusCurp
returns acronyms, which mean the following:
For active CURP: AN (Alta Normal), AH (Alta con Homonimia), CRA CU (CURP Reactivada), RCN (Registro de Cambio no Afectando a CURP), RCC (Registro de Cambio Afectando a CURP)
For inactive CURP: BD (Baja por Defuncion), BDA (Baja por Duplicidad), BCC (Baja por Cambio en CURP), BCN (Baja no Afectando a CURP)
Request properties explained
*Required field
curp_registry
id
:string
* UUID for the session where this check was executedvendorData
:string | null
* The unique identifier that you created for your end-user.null
if not specifiedendUserId
:string | null
* TheUUID
identifier that you created for your end-user.null
if not specifiedversion
:string
* Version number of the checkdata
:object | null
* Array of data objectsattemptId
:string
UUID v4 which identifies session attemptname
:string
Name of the checkstatus
:string
Status of the data, one offound
,not found
code
: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 registrystatusCurp
:string | null
CURP data status acronym, one ofAN
,AH
,CRA CU
,RCN
,RCC
,BD
,BDA
,BCC
,BCN
curp
:string
18-character alphanumeric code of the person (the CURP identification number)description
:string
Explanation of thedetails.statusCurp
value