/verify/id_check

1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample

1.API Specification

This API is used to verify Mexico CURP Number.

Request Method

POST

Request URL

https://cloudapi.mexico.accuauth.com/verify/id_check

Debugging Tool

Debugging Tool

2.Request Params

2.1 Request Header

Parameter Type Required Description
X-DF-API-ID string Yes For API credentials，Please visit API Request
X-DF-API-SECRET string Yes For API credentials，Please visit API Request

2.2 Request Body

Required Fields Type Description
required id_number string ID number

3.Response Params

Fields Type Description
request_id string Unique id of each request
status string Response status, OK for success request, Error Codes for failed request
result_code string Result code
result_message string Result message
result object The verification result

3.1 Result Codes

Value Description Billable
0 Success Yes
1 ID number not exist Yes
2 ID number format error Yes
3 Invalid ID number Yes
5 Data error No

3.2 Elements in `result`

Fields Type Description
estatus string OK or ERROR
codigoValidacion string Validation code
curp string CURP(ID number)
nombre string Name
apellidoPaterno string Last name
apellidoMaterno string Mother's last name
sexo string Gender, HOMBRE(MALE) or MUJER(FEMALE)
fechaNacimiento string birth date, format as DD/MM/YYYY
paisNacimiento string Country of birth
estadoNacimiento string State of birth
docProbatorio integer Possible values: 1: Birth certificate; 3: Migration document; 4: Naturalization Certificate; 7: Certificate of mexican nationality; 8: Procedure with the SEGOB
datosDocProbatorio object Evidence data, see Evidence data for detail
estatusCurp string Status of CURP, see Possible values for estatusCurp
codigoMensaje string Same as result_code
documento string Base64 encoded pdf document

3.3 Possible values for field `estatusCurp`

Value Status Description
AN Active Normal registration
AH Active Registration with homonymy
RCC Active Registration change affecting CURP
RCN Active Registration change not affecting CURP
BAP Not active Unsubscribed because apocryphal document
BSU Not active Unsubscribed without use
BD Not active Unsubscribed because of deceased
BDM Not active Administrative unsubscription
BDP Not active Unsubscribed because of adoption
BJD Not active Judicial unsubscription

3.4 Elements in field `datosDocProbatorio`

Fields Type Description
entidadRegistro string Registry entity
claveMunicipioRegistro string Municipality registry key
anioReg string Registry year
claveEntidadRegistro string Entity registry key
numActa string Act number
municipioRegistro string Entity registry
libro string Book, the physical document where the person was registered
tomo string The volume in the book
foja string The page
Response Syntax
{
    "status": "OK",
    "result_code": "0",
    "result_message": "success",
    "result": {
        "estatus": "OK",
        "codigoValidacion": "vc16752xxxxx1.73xxxxxx",
        "curp": "RAZR81101xxxxxxxx",
        "nombre": "ROBERTO ALONSO",
        "apellidoPaterno": "RAXXX",
        "apellidoMaterno": "ZAPAXX",
        "sexo": "HOMBRE",
        "fechaNacimiento": "11/10/1981",
        "paisNacimiento": "MEXICO",
        "estadoNacimiento": "VERACRUZ",
        "docProbatorio": 1,
        "datosDocProbatorio": {
            "entidadRegistro": "VERACRUZ",
            "tomo": "",
            "claveMunicipioRegistro": "108",
            "anioReg": "1983",
            "claveEntidadRegistro": "30",
            "foja": "",
            "numActa": "03382",
            "libro": "",
            "municipioRegistro": "MINATITLÁN"
        },
        "estatusCurp": "RCN",
        "codigoMensaje": "0",
        "documento": "Base64 encoded data"
    },
    "request_id": "TID6f814b81bfb44c97a63b13e2750a3a2a"
}

4.Error Codes

Common error codes of this API:

Http Status Code Status Field Description
400 INVALID_ARGUMENT Request parameter is invalid
400 VERIFY_FAILED Verify failed
400 PENDING Operation in progress, try again later
400 ABNORMAL_BEHAVIOURS_DETECTED Request with same parameters repeated more than amount of times
401 UNAUTHORIZED Unauthorized or access is denied
401 KEY_EXPIRED Your API ID has expired
403 NO_PERMISSION You are not authorized to use this API
403 OUT_OF_QUOTA API calls quota exceeded
403 RATE_LIMIT_EXCEEDED API request frequency exceeds the limit
404 NOT_FOUND Requested API cannot be found
500 INTERNAL_ERROR Internal server error
512 SOURCE_SERVICE_UNAVAILABLE Source service is unavailable
513 SOURCE_SERVICE_TIMEOUT Source service is timeout

Comment: Please see the reason field for details when the above 40X / 51X error occurred

Response Syntax
{
  "status": "INVALID_ARGUMENT",
  "reason": "argument 'id_number': not found",
  "request_id": "TID8bf47ab6eda64476973cc5f5b6ebf57e"
}

5.Sample

results matching ""

    No results matching ""