ID Verification -Pakistan

ID Verification API Integration Guide

Overview

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

API Methods

Base URL

Pakistan: ID Verification Endpoint

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	Notes
partner_code	String	Partner Code	Required	Assigned by TD
partner_key	String	Partner Key	Required	Assigned by TD

Request Parameters

Parameter	Type	Description	Required	Notes
id_number	String	ID number	Required	13-digit ID number
id_type	String	ID type	Required	Pakistan: CNIC or NIC
phone_number	String	Phone number	Required	Format: 3XZYYYYYYY
country	String	Country	Required	Two-digit country code (ISO 3166) Currently supported: Pakistan (PK)

Request Example

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

Response Parameters

Parameter	Type	Description	Required	Notes
code	Integer	API status code	Required	-
message	String	Status information	Required	Success or specific error details
sequence_id	String	Response unique code	Required	Tracks each request
result	String	Verification results	Required	Enumeration: pass, fail, no record

API Status Codes

Code	Message	Description	Charged
200	Success	Successful verification	YES
300	Service not effective	Service not purchased or inactive	NO
301	Service not purchased	Service unavailable	NO
302	Service suspended	Service has been suspended	NO
303	Insufficient balance	Not enough balance	NO
304	Service expired	Service expired	NO
11350	Internal error	Internal system error	NO
11301	`{parameter}` empty	Missing required parameter	NO
11304	Country not supported	No service in your country/region	NO
11340	`{parameter}` error	Parameter validation failed	NO

Response Examples

Success Response

{
    "code": 200,
    "message": "Success",
    "sequence_id": "1648777165770866F82AC7F326307055",
    "result": "pass"
}

Failure Response

{
    "code": 11350,
    "message": "Internal error",
    "sequence_id": "170427842997****I3167369D6187177",
    "result": "fail"
}