护照识别
功能介绍
识别护照首页图片中的文字信息，并以JSON格式返回识别的结构化结果。
前提条件
在使用之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通服务和认证鉴权章节。
用户首次使用需要先。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。
URI
POST https://{endpoint}/v2/{project_id}/ocr/passport
|
参数 |
是否必选 |
说明 |
|---|---|---|
|
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 |
否 |
String |
该参数与url二选一。 图片的Base64编码，要求Base64编码后大小不超过10MB。 图片最短边不小于15px，最长边不超过4096px，支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。 |
|
url |
否 |
String |
该参数与image二选一。图片的url路径，目前支持：
说明：
|
响应参数
根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
PassportResult object |
调用结果。 调用失败时不返回此字段。 该结果中包含：13个主要字段，由英文表达；extra_info由本地官方语言表达；主要字段的置信度。置信度越大，字段的值越准确。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
country_code |
String |
护照签发国的国家码。 |
|
passport_number |
String |
护照号码。 |
|
surname |
String |
姓。 |
|
given_name |
String |
名字。 |
|
sex |
String |
性别。 |
|
date_of_birth |
String |
出生日期。返回值例如，1990-12-12。 |
|
date_of_expiry |
String |
护照有效期。返回值例如，2020-07-08。 |
|
confidence |
Object |
字段的置信度，取值范围0~1。 置信度越大，表示识别的字段的可靠性越高，在统计意义上，置信度越大，准确率越高。 置信度由算法给出，不直接等价于字段的准确率。 |
|
extra_info |
Object |
默认为空。 |
状态码： 400
|
参数 |
参数类型 |
说明 |
|---|---|---|
|
error_code |
String |
调用失败时的错误码，具体请参见错误码。 调用成功时不返回此字段。 |
|
error_msg |
String |
调用失败时返回的错误信息。 调用成功时不返回此字段。 |
请求示例
- 请求样例（方式一：使用图片的Base64编码）
POST https://ocr.ae-ad-1.g42cloud.com/v2/{project_id}/ocr/passport Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", } - 请求样例（方式二：使用图片URL）
POST https://ocr.ae-ad-1.g42cloud.com/v2/{project_id}/ocr/passport Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", }
响应示例
状态码：200
{
"result": {
"country_code": "ETF",
"surname": "HUZHAO",
"given_name": "ZHAOMIN DESALEGN ",
"passport_number": "EP435XXXX",
"date_of_birth": "1985-09-18",
"sex": "M",
"date_of_expiry": "2022-01-15",
"machine_code": "P<ETFHUZHAO<< ZHAOMIN <DESALEGN<<<<<<<<<<<<<<<",
"machine_code2": "EP435XXXX7ETF8509185M2201155<<<<<<<<<<<<<<08",
"extra_info": {},
"confidence": {
"country_code": 0.9727,
"surname": 0.9727,
"given_name": 0.9727,
"passport_number": 0.9558,
"date_of_birth": 0.9558,
"sex": 0.9558,
"date_of_expiry": 0.9558
}
}
}
状态码：400
失败响应示例
{
"error_code": "AIS.0103",
"error_msg": "The image size does not meet the requirements."
}
错误码
错误码请参见错误码。
