CURP webhook

  • Updated on Feb 25, 2025
Prev Next

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

  1.  Make sure you have access to the Veriff Customer Portal
    1. If you do not, see the Getting Started → Sign up and Log in articles
  2.  Set up webhook URL(s) on your side and have them at hand
    1.  Make sure they match the Webhook URL requirements
    2. Make sure your system is able to handle Webhooks receipt, delivery and resending requirements
  3. Secure your communication, check the HMAC Authentication and Endpoint Security article
  4. Make sure your system is able to handle the Backwards compatible changes

5.Proceed to CURP webhook setup

CURP webhook setup

  1. Log in to the Veriff Customer Portal

  2. Navigate to the Integrations page via the top menu and open the integration used for the registry check

  3. On the integration's page, select the Settings tab

  4. Under the title Integration settings you see a list of webhooks

  5. 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 executed

  • vendorData: string | null* The unique identifier that you created for your end-user. null if not specified

  • endUserId: string | null* The UUID identifier that you created for your end-user. null if not specified

  • version: string* Version number of the check

  • data: object | null* Array of data objects

    • attemptId: string UUID v4 which identifies session attempt

    • name: string Name of the check

    • status: string Status of the data, one of found, not found

    • code: number An integer number of the HTTP status code. See the Common HTTP status codes table for more info

    • details: object Details connected to the specific check against the registry

      • statusCurp: string | null CURP data status acronym, one of AN, 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 the details.statusCurp value

Related articles