API Reference
中文

ID Verification -Pakistan

ID verification is mainly focus on the validation of two essential elements.

API Methods

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 numberRequiredID number, 13 digits
id_typeStringID typeRequiredPakistan- enumeration value: CNIC / NIC
phone_numberStringPhone numberRequiredSample:3XZYYYYYYY
countryStringCountryRequiredTwo-digit country code, compliant with ISO 3166 standard.
Currently supported: Pakistan(PK)

Request Example

{
    "country": "PK",
    "phone_number": "3008419184",
    "id_type": "CNIC",
    "id_number": "4430207575177"
}

Response Parameter

ParameterTypeDescriptionRequired/OptionalNotes
codeIntegerAPI status codeRequired
messageStringStatus informationRequiredReturns ‘success’ when the API call is successful;Specific abnormal reasons will be provided when the API is abnormal
sequence_idStringResponse unique codeRequiredUnique identifier used to track each request record
resultStringVerification resultsRequiredEnumeration value :pass; fail; no record

API Interface Response Code

codeMessageDescriptionCharged
200successSuccessYES
300Service not purchased or not effectiveService not purchased or not effectiveNO
301Service not purchasedService not purchasedNO
302Service has been suspendService has been suspendNO
303Not enough balanceNot enough balanceNO
304Service expiredService expiredNO
11350Internal errorInternal errorNO
11301{parameter} empty{parameter} emptyNO
11304The country partner located is not openThere is no service in your country/regionNO
11340{parameter} error{parameter} errorNO

Response Example

  • Success
{
    "code": 200,
    "message": "Success",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "result": "pass"
}
  • Failure
{
    "code": 11350,
    "message": "Internal error",
    "sequence_id": "170427842997****I3167369D6187177",
    "result": "fail"
}