菲律宾 UMID OCR

CRN + 名称识别

代码示例：

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

识别成功的响应

{
  "status": "OK",
  "message": {
    "crn": "CRN-0028-1215160-9",
    "surname": "SANTOS",
    "givenName": "JOSE",
    "MiddleName": "CRUZ",
    "birthday": "1960/01/28",
    "sex": "M",
    "address": "28 PAYAPA ST BAGONG DIWA STO CRISTOBAL CAL OOCAN CITY METRO MANILA PHILIPPINES 1800"
  }
}

识别失败的响应

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

无效请求参数的响应

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

请求参数

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

响应格式

字段	描述
`status`	状态码
`message`	`crn`：CRN 号码
`surname`: 姓
`givenName`: 名字
`middleName`: 中间名
`birthday`: 出生日期
`sex`: 性别
`address`: 地址

状态码

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