跳转到内容
eKYC Pro API 文档

马来西亚身份证OCR

识别马来西亚身份证正面

代码示例：

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

身份证正面识别成功的响应

{
  "status": "OK",
  "message": {
    "CardNumber": "460619-12-5087",
    "DateOfBirth": "19460619",
    "Gender": "LELAKI",
    "Name": "ABD RAUF BIN HAMSAH",
    "Address": "KAMPUNG MASJID PO BOX 42 89007 KENINGAU SABAH"
  }
}

识别失败的响应

{
  "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/my_ocr/general

请求参数

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

身份证响应格式

字段描述
status状态码
messageCardNumber: 身份证号码
Name: 姓名
Gender: 性别
DateOfBirth: 出生日期
Address: 地址

状态码

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

Products