API Reference
中文

ID Verification -Mexico

ID verification is used to verify the authenticity of user ID information.

API Method

Base URL

API

URLRequest MethodsContent-TypeOutput FormatCharacter Set
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8
Authentication
ParameterTypeDescriptionRequired/OptionalNotes
partner_codeStringPartner CodeRequiredAssigned by TD
partner_keyStringPartner KeyRequiredAssigned by TD

Request

ParameterTypeDescriptionRequired/OptionalNotes
id_numberStringID typeRequiredID number
id_typeStringID numberRequiredEnumeration: national_id
countryStringCountryRequired2-letter country code according to ISO 3166
Support: MX(Mexico)

Response Parameter

ParameterTypeDescriptionRequired/OptionalDescription
codeIntegerAPI status codeRequired
messageStringStatus InformationRequiredSpecific abnormal reasons will be provided when the API is abnormal
sequence_idStringUnique response codeRequiredA unique ID used to track each request
resultStringResultRequiredEnumeration:
1.
2. fail
id_infoJSONObjectID card informationConditionally RequiredReturned 200 when result is success
  • Id_info structure
    ParameterTypeDescription
    curpStringCURP(ID number)
    nombreStringName
    apellido_paternoStringLast name
    apellido_maternoStringMother's last name
    sexoStringGender
    fecha_nacimientoStringBirth date, format as DD/MM/YYYY
    pais_nacimientoStringCountry of birth
    estado_nacimientoStringState of birth
    datos_doc_probatorioObjectEvidence data
    estatus_curpStringStatus of CURP, Active or Not Active
datos_doc_probatorio数据结构
ParameterTypeDescription
entidad_registroStringRegistry entity
clave_municipio_registroStringMunicipality registry key
anio_regStringRegistry year
clave_entidad_registroStringEntity registry key

API Status Code

Code MessageDescriptionCharged
200successSuccessYES
301Service not purchasedService not purchasedNO
302Traffic blockedTraffic blockedNO
303Traffic insufficientTraffic insufficientNO
304Service expiredService expiredNO
305Daily maximum volume reachedDaily maximum volume reachedNO
600Service Temporarily UnavailableService reached limitNO
11350Internal errorInternal errorNO
11301{parameter} empty{parameter} emptyNO
11304The country partner located is not openThe country partner located is not openNO
11340{parameter} error{parameter} errorNO
12701CURP not existCURP not existYES
12008Service unavailable, please retry laterService unavailable, please retry laterNO

Response Example

  • Request

    {
      "country": "MX",
      "id_type": "national_id",
      "id_number": "xxxxxxxxxx"
    }
    
  • Success

{
    "result": "success",
    "code": 200,
    "sequence_id": "53b63090c0374cad82f26a5aa4f8991e",
    "message": "success",
    "id_info": {
        "datos_doc_probatorio": {
            "clave_entidad_registro": "09",
            "entidad_registro": "DISTRITO FEDERAL",
            "municipio_registro": "",
            "clave_municipio_registro": "010",
            "anio_reg": "1978"
        },
        "fecha_nacimiento": "22/08/1978",
        "estatus_curp": "Active",
        "nombre": "ARTURO",
        "apellido_paterno": "MARRUENDA",
        "apellido_materno": "HUESCA",
        "estado_nacimiento": "DISTRITO FEDERAL",
        "pais_nacimiento": "MEXICO",
        "sexo": "HOMBRE",
        "curp": "MAHA78****HDFRSR07"
    }
}
  • Failed
{
    "result": "fail",
    "code": 11301,
    "sequence_id": "69b57131b6fb********61ccba118b60",
    "message": "Country error"
}