ID verification is mainly focus on the validation of two essential elements.
URL | Request Methods | Content-Type | Output Format | Character Set |
---|
api-base-url?partner_code=xxx&partner_key=xxx | POST | application/json | JSON | UTF-8 |
Parameter | Type | Description | Required/Optional | Notes |
---|
partner_code | String | Partner Code | Required | assigned by TD |
partner_key | String | Partner Key | Required | assigned by TD |
Parameter | Type | Description | Required/Optional | Notes |
---|
id_number | String | ID number | Required | ID number, 13 digits |
id_type | String | ID type | Required | Pakistan- enumeration value: CNIC / NIC |
phone_number | String | Phone number | Required | Sample:3XZYYYYYYY |
country | String | Country | Required | Two-digit country code, compliant with ISO 3166 standard. Currently supported: Pakistan(PK) |
{
"country": "PK",
"phone_number": "3008419184",
"id_type": "CNIC",
"id_number": "4430207575177"
}
Parameter | Type | Description | Required/Optional | Notes |
---|
code | Integer | API status code | Required | |
message | String | Status information | Required | Returns ‘success’ when the API call is successful;Specific abnormal reasons will be provided when the API is abnormal |
sequence_id | String | Response unique code | Required | Unique identifier used to track each request record |
result | String | Verification results | Required | Enumeration value :pass; fail; no record |
code | Message | Description | Charged |
---|
200 | success | Success | YES |
300 | Service not purchased or not effective | Service not purchased or not effective | NO |
301 | Service not purchased | Service not purchased | NO |
302 | Service has been suspend | Service has been suspend | NO |
303 | Not enough balance | Not enough balance | NO |
304 | Service expired | Service expired | NO |
11350 | Internal error | Internal error | NO |
11301 | {parameter} empty | {parameter} empty | NO |
11304 | The country partner located is not open | There is no service in your country/region | NO |
11340 | {parameter} error | {parameter} error | NO |
{
"code": 200,
"message": "Success",
"sequence_id": "1648777165770866F82AC7F326307055",
"result": "pass"
}
{
"code": 11350,
"message": "Internal error",
"sequence_id": "170427842997****I3167369D6187177",
"result": "fail"
}