Pakistan ID Card OCR

id number + name recognition

Code example:

curl --location --request POST 'https://api.ekycpro.com/v1/pk_ocr/general' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-API-Key: AbcdEfgh' \
--data-urlencode 'img=BASE64_ENCODE_VALUE'

Response for ID card recognition success

{
  "status": "OK",
  "message": {
    "idNumber": "33100-7411692-4",
    "name": "Janat Mirza",
    "fatherName": "Mirza Anjum Kamal",
    "gender": "F",
    "country": "Pakistan",
    "birthDay": "20010914",
    "issueDay": "20200309",
    "expiryDay": "20300309"
  }
}

Response for recognition fail

{
  "status": "FAIL",
  "message": "check input image and retry"
}

Response for not recognized card type

{
  "status": "FAIL",
  "message": "not identity card"
}

Response for invalid request parameters

{
  "status": "INVALID_REQUEST",
  "message": "check request params"
}

Response for invalid image format

{
  "status": "IMAGE_INVALID_FORMAT",
  "message": "image format not support"
}

Response for image size larger than 2M

{
  "status": "IMAGE_INVALID_SIZE",
  "message": "image larger than 2M"
}

Response for server error

{
  "status": "INNER_ERROR",
  "message": "Inner error, please retry later"
}

HTTP request

POST https://api.ekycpro.com/v1/pk_ocr/general

Request parameters

parameter	description
img	string, base64 encoded image. It is recommended that the image be less than 200KB, so it will be returned within 2 seconds, otherwise the return time will be longer.

Response format for ID card

fields	description
status	status code
message	idNumber: card number name: name fatherName: father name gender: gender country: country birthDay: birth day issueDay: issue day expiryDay: expiry day

Status code

status	description
OK	charge, success
FAIL	charge, image recognition error, please check input image
INVALID_REQUEST	free, invalid request parameters
IMAGE_INVALID_FORMAT	free, invalid image format, image format should be one of jpeg/jpg/png/bmp
IMAGE_INVALID_SIZE	free, invalid image size, should be less than 2M
INNER_ERROR	free, server error