阿联酋身份证识别
功能介绍
识别阿联酋身份证图片中的文字内容，并将识别的结果以JSON格式返回给用户。
前提条件
在使用阿联酋身份证识别之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通服务和认证鉴权章节。
用户首次使用需要先开通服务。（服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。）
URI
POST https://{endpoint}/v2/{project_id}/ocr/emirates-id-card
|
参数 |
是否必选 |
说明 |
|---|---|---|
|
endpoint |
是 |
指定承载REST服务端点的服务器域名或IP，不同服务不同区域的endpoint不同，您可以从终端节点中获取。 |
|
project_id |
是 |
项目ID，您可以从获取账号ID和项目ID中获取。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 |
|
Content-Type |
是 |
String |
发送的实体的MIME类型，参数值为“application/json”。 |
|
参数 |
是否必选 |
参数类型 |
说明 |
|---|---|---|---|
|
image |
否，该参数与url二选一 |
String |
图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过8192px，支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 |
|
url |
否，该参数与image二选一 |
String |
图片的URL路径。
说明：
|
|
side |
否 |
String |
如果参数值为空或无该参数，系统自动识别，建议填写，准确率更高。 |
响应参数
根据识别的结果，可能有不同的HTTP响应状态码（status code），状态码和响应参数说明如下。
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Object |
调用结果。 调用失败时不返回此字段。 |
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
side |
String |
front：身份证正面 back：身份证背面 |
|
id_number |
String |
身份证号。 |
|
name_arabic |
String |
阿拉伯语姓名。 |
|
name |
String |
姓名。 |
|
nationality_arabic |
String |
阿拉伯语国籍。 |
|
nationality |
String |
国籍。 |
|
sex |
String |
性别。 |
|
date_of_birth |
String |
出生日期。 |
|
expiry_date |
String |
身份证有效期。 |
|
card_number |
String |
身份证卡号。 |
|
country_code |
String |
身份证签发国的国家码。 |
|
machinecode1 |
String |
身份证背面第一行机器码。 |
|
machinecode2 |
String |
身份证背面第二行机器码。 |
|
machinecode3 |
String |
身份证背面第三行机器码。 |
|
confidence |
Object |
字段的置信度，取值范围0~1。 置信度越大，本次识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
调用失败时的错误码，具体请参见错误码。 调用成功时不返回此字段。 |
|
error_msg |
String |
调用失败时返回的错误信息。 调用成功时不返回此字段。 |
请求示例
- 请求示例（方式一：使用图片的Base64编码）
POST https://ocr.ae-ad-1.g42cloud.com/v2/{project_id}/ocr/emirates-id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAA..." } - 请求示例（方式二：使用图片URL）
POST https://ocr.ae-ad-1.g42cloud.com/v2/{project_id}/ocr/emirates-id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }
响应示例
状态码：200
成功响应示例（正面）
{
"result": {
"side": "front",
"id_number": "784-XXXX-XXXXXXX-X",
"name": "XXX",
"name_arabic": "XXX",
"nationality": "Egypt",
"nationality_arabic": "مصر",
"confidence": {
"id_number": 0.9712,
"name": 0.9731,
"name_arabic": 0.9234,
"nationality": 0.9543
"nationality_arabic": 0.9543,
}
}
}
成功响应示例（背面）
{
"result": {
"side": "back",
"card_number": "XXXX-XXX-XX",
"laser_number": "XXXX-XXXXXXX-XX",
"confidence": {
"id_number": 0.9999,
"laser_number": 0.9994
}
}
}
状态码：400
失败响应示例
{
"error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
错误码
错误码请参见错误码。
