跳转到内容

加纳身份证OCR

身份证号码 + 姓名识别

代码示例:

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

识别成功的响应

{
"status": "OK",
"message": {
"dateOfBirth": "02/02/1990",
"dateOfExpiry": "14/05/2029",
"dateOfIssue": "16/05/2019",
"documentId": "AC2938503",
"firstname": "PRINCE DAVID OPPONG",
"gender": "M",
"nationality": "GHANAIAN",
"personalId": "GHA-712808643-8",
"placeOfIssue": "ACCRA",
"surname": "OBENG"
}
}

识别失败的响应

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

输入图像不是身份证的响应

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

无法识别的卡类型的响应

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

无效请求参数的响应

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

请求参数

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

响应格式

字段描述
status状态码
messagepersonalId: 个人身份证号码
surname: 姓
firstname: 名字
gender: 性别
nationality: 国籍
placeOfIssue: 签发地点
dateOfBirth: 出生日期
dateOfExpiry: 过期日期
dateOfIssue: 签发日期
documentId: 文档编号

状态码

状态码描述
OKcharge,成功
FAILcharge,图像识别错误,请检查输入图像
INVALID_REQUESTfree,无效的请求参数
IMAGE_INVALID_FORMATfree,无效的图像格式,图像格式应为 jpeg/jpg/png/bmp 之一
IMAGE_INVALID_SIZEfree,无效的图像大小,应小于 2M
INNER_ERRORfree,服务器错误