跳转到内容
eKYC Pro API 文档

巴基斯坦身份证OCR

身份证号码 + 姓名识别

代码示例：

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'

身份证识别成功的响应

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

身份证识别失败的响应

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

未识别到身份证类型的响应

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

无效请求参数的响应

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

图像格式无效的响应

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

图像大小超过 2M 的响应

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

服务器错误的响应

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

HTTP 请求

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

请求参数

参数描述
imgstring，base64 编码的图像。建议图像大小小于 200KB，以便在 2 秒内返回结果，否则返回时间会更长。

身份证响应格式

字段描述
status状态码
messageidNumber: 身份证号码
name: 姓名
fatherName: 父亲姓名
gender: 性别
country: 国家
birthDay: 出生日期
issueDay: 签发日期
expiryDay: 过期日期

状态码

状态码描述
OK成功
FAIL图像识别错误，请检查输入图像
INVALID_REQUEST无效的请求参数
IMAGE_INVALID_FORMAT无效的图像格式，图像格式应为jpeg/jpg/png/bmp之一
IMAGE_INVALID_SIZE图像大小无效，应小于2M
INNER_ERROR服务器错误

Products