ID verification is used to verify the authenticity of user ID information.
API Method
Base URL
- Singapore：https://sg.apitd.net/verification/kyc/idverify/v1
- Mexico：https://mx.apitd.net/verification/kyc/idverify/v1
API
| URL | Request Methods | Content-Type | Output Format | Character Set |
|---|---|---|---|---|
| api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
Authentication
| Parameter | Type | Description | Required/Optional | Notes |
|---|---|---|---|---|
| partner_code | String | Partner Code | Required | Assigned by TD |
| partner_key | String | Partner Key | Required | Assigned by TD |
Request
| Parameter | Type | Description | Required/Optional | Notes |
|---|---|---|---|---|
| id_number | String | ID type | Required | ID number |
| id_type | String | ID number | Required | Enumeration: national_id |
| country | String | Country | Required | 2-letter country code according to ISO 3166 Support: MX(Mexico) |
Response Parameter
| Parameter | Type | Description | Required/Optional | Description |
|---|---|---|---|---|
| code | Integer | API status code | Required | |
| message | String | Status Information | Required | Specific abnormal reasons will be provided when the API is abnormal |
| sequence_id | String | Unique response code | Required | A unique ID used to track each request |
| result | String | Result | Required | Enumeration: 1. 2. fail |
| id_info | JSONObject | ID card information | Conditionally Required | Returned 200 when result is success |
-
Id_info structure
Parameter Type Description curp String CURP(ID number) nombre String Name apellido_paterno String Last name apellido_materno String Mother's last name sexo String Gender fecha_nacimiento String Birth date, format as DD/MM/YYYYpais_nacimiento String Country of birth estado_nacimiento String State of birth datos_doc_probatorio Object Evidence data estatus_curp String Status of CURP, Active or Not Active
datos_doc_probatorio数据结构
datos_doc_probatorio数据结构| Parameter | Type | Description |
|---|---|---|
| entidad_registro | String | Registry entity |
| clave_municipio_registro | String | Municipality registry key |
| anio_reg | String | Registry year |
| clave_entidad_registro | String | Entity registry key |
API Status Code
| Code | Message | Description | Charged |
|---|---|---|---|
| 200 | success | Success | YES |
| 301 | Service not purchased | Service not purchased | NO |
| 302 | Traffic blocked | Traffic blocked | NO |
| 303 | Traffic insufficient | Traffic insufficient | NO |
| 304 | Service expired | Service expired | NO |
| 305 | Daily maximum volume reached | Daily maximum volume reached | NO |
| 600 | Service Temporarily Unavailable | Service reached limit | NO |
| 11350 | Internal error | Internal error | NO |
| 11301 | {parameter} empty | {parameter} empty | NO |
| 11304 | The country partner located is not open | The country partner located is not open | NO |
| 11340 | {parameter} error | {parameter} error | NO |
| 12701 | CURP not exist | CURP not exist | YES |
| 12008 | Service unavailable, please retry later | Service unavailable, please retry later | NO |
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"
}