文档首页/ 文字识别 OCR/ API参考/ API/ 身份证识别

更新时间：2024-11-27 GMT+08:00

在线调试

CLI示例

查看PDF

身份证识别

功能介绍

识别身份证图片中的文字内容，并将识别的结果以JSON格式返回给用户。支持身份证翻拍、PS、模糊、反光、边框完整性、边框内异物遮挡、复印件和临时身份证告警功能。

该接口的使用限制请参见约束与限制，详细使用指导请参见OCR服务使用简介章节。

身份证信息核验请使用人证核身服务。

图1 身份证示例图

身份证识别支持中华人民共和国居民身份证识别。

如果图片中包含多张卡证票据，请调用智能分类识别服务。

约束与限制

支持中华人民共和国居民身份证的识别。
只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。
图像各边的像素大小在15px到8192px之间。
图像中身份证区域有效占比超过25%，保证整张身份证内容及其边缘包含在图像内。
支持图像中身份证任意角度的水平旋转。
支持少量扭曲，扭曲后图像中的身份证长宽比与实际身份证相差不超过10%。
能处理反光、暗光等干扰的图片但影响识别精度。
目前支持识别单张身份证的正面或者反面。
支持居民身份证的正反面同时识别，不支持存在两张及以上同面身份证的图片识别。

调用方法

请参见如何调用API。

前提条件

在使用之前，需要您完成服务申请和认证鉴权，具体操作流程请参见开通服务和认证鉴权章节。

用户首次使用需要先申请开通。服务只需要开通一次即可，后面使用时无需再次申请。如未开通服务，调用服务时会提示ModelArts.4204报错，请在调用服务前先进入控制台开通服务，并注意开通服务区域与调用服务的区域保持一致。

URI

POST /v2/{project_id}/ocr/id-card

表1 路径参数
参数	是否必选	说明
endpoint	是	终端节点，即调用API的请求地址。不同服务不同区域的endpoint不同，您可以从终端节点中获取。例如，OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。
project_id	是	项目ID，您可以从获取项目ID中获取。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。
Content-Type	是	String	发送的实体的MIME类型，参数值为“application/json”。
Enterprise-Project-Id	否	String	企业项目ID。OCR支持通过企业项目管理（EPS）对不同用户组和用户的资源使用，进行分账。获取方法：进入“企业项目管理”页面，单击企业项目名称，在企业项目详情页获取Enterprise-Project-Id（企业项目ID）。企业项目创建步骤请参见用户指南。说明：创建企业项目后，在传参时，有以下三类场景。携带正确的ID，正常使用OCR服务，账单的企业项目会被分类到企业ID对应的企业项目中。携带格式正确但不存在的ID，正常使用OCR服务，账单的企业项目会显示对应不存在的企业项目ID。不携带ID或格式错误ID（包含特殊字符等），正常使用OCR服务，账单的企业项目会被分类到"default"中。

表3 请求Body参数
参数	是否必选	参数类型	说明
image	否	String	该参数与url二选一。图片的Base64编码，要求Base64编码后大小不超过10MB。图片最短边不小于15px，最长边不超过8192px。支持JPEG、JPG、PNG、BMP、TIFF格式。图片Base64编码示例如/9j/4AAQSkZJRgABAg...，带有多余前缀会产生The image format is not supported报错。
url	否	String	该参数与image二选一。图片的url路径，目前支持：公网http/https url例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0000001079447456.png OBS提供的url，使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权，详情参见配置OBS访问权限。说明：接口响应时间依赖于图片的下载时间，如果图片下载时间过长，会返回接口调用失败。请保证被检测图片所在的存储服务稳定可靠，推荐使用OBS服务存储图片数据。 url中不能存在中文字符，若存在，中文需要进行utf8编码。
side	否	String	检测身份证的人像面或国徽面。 front：身份证人像面 back：身份证国徽面 double_side：身份证双面信息如果参数值为空或无该参数，系统自动识别，建议填写，准确率更高。
return_verification	否	Boolean	返回校验身份证号等信息的开关，默认false，可选值如下所示： true：返回校验信息 false：不返回校验信息
return_text_location	否	Boolean	识别到的文字块的区域位置信息。可选值包括： true：返回各个文字块区域 false：不返回各个文字块区域如果无该参数，系统默认不返回文字块区域。如果输入参数不是Boolean类型，则会报非法参数错误。
return_portrait_image	否	Boolean	返回头像图片信息（base64码）的开关，默认false，可选值如下所示： true ：开启头像图片信息（base64码）的功能 false : 关闭头像图片信息（base64码）的功能
return_adjusted_image	否	Boolean	返回身份证卡面（base64码）的开关，默认false，可选值如下所示： true ：开启身份证卡面（base64码）的功能 false : 关闭身份证卡面（base64码）的功能
return_portrait_location	否	Boolean	返回头像位置信息的开关，默认false，可选值如下所示： true ：开启返回头像位置信息的功能 false : 关闭返回头像位置信息的功能
detect_reproduce	否	Boolean	返回判断身份证图像是否经过翻拍的开关，默认false，可选值如下所示： true ：开启判断身份证图像是否经过翻拍功能 false：关闭判断身份证图像是否经过翻拍功能
detect_copy	否	Boolean	返回判断身份证图像是否是黑白复印件的开关，默认false，可选值如下所示： true ：开启判断身份证图像是否是复印件功能 false : 关闭身份证图像是否是复印件功能
detect_tampering	否	Boolean	身份证图像PS告警功能开关，默认false，可选值如下： true ：开启身份证图像PS告警功能 false : 关闭身份证图像告警功能说明：身份证PS告警功能不支持精细化P图。
detect_border_integrity	否	Boolean	身份证图像边框完整性告警功能开关，默认false，可选值如下： true ：打开身份证图像边框完整性告警功能 false : 关闭身份证图像边框完整性告警功能
detect_blocking_within_border	否	Boolean	身份证图像边框内部是否有异物遮挡的告警功能开关，默认false，可选值如下： true ：开启身份证边框内部异物遮挡告警功能 false : 关闭身份证边框内部异物遮挡告警功能
detect_blur	否	Boolean	身份证图像模糊告警功能的开关，默认false，可选值如下： true ：开启身份证图像模糊告警功能 false : 关闭身份证图像模糊告警功能
detect_interim	否	Boolean	临时身份证告警功能开关，默认false，可选值如下： true ：开启临时身份证告警功能 false : 关闭临时身份证告警功能
detect_glare	否	Boolean	身份证反光告警功能开关，默认false，可选值如下： true ：开启身份证反光告警功能 false : 关闭身份证反光告警功能

响应参数

根据识别的结果，可能有不同的HTTP响应状态码（status code）。例如，200表示API调用成功，400表示调用失败，详细的状态码和响应参数说明如下。

状态码： 200

表4 响应Body参数
参数	参数类型	描述
result	IDCardResult object	识别结果。调用失败时不返回此字段。

表5 IdCardResult
参数	参数类型	描述
name	String	姓名。
sex	String	性别。
birth	String	出生日期。
ethnicity	String	民族。
address	String	地址。
number	String	身份证号。
issue	String	发证机关。
valid_from	String	有效起始日期。
valid_to	String	有效结束日期。
verification_result	IdcardVerificationResult object	校验信息。仅在输入参数return_verification为true时，返回该字段，该字段包含valid_number、valid_birth、valid_sex、valid_validity_period和valid_date的校验信息。
text_location	Object	对应所有在原图上识别到的字段位置信息，包含所有文字区域四个顶点的二维坐标（x,y）。采用图像坐标系，坐标原点为图片左上角，x轴沿水平方向，y轴沿竖直方向。
portrait_image	String	身份证头像图片信息的base64码结果。说明：仅在输入参数return_portrait_image为true时，返回该字段。当输入为身份证背面时返回为空字符串。
adjusted_image	String	身份证卡面图片信息的base64码结果。说明：仅在输入参数return_adjusted_image为true时，返回该字段。
portrait_location	Array<Array<Integer>>	身份证头像位置信息的结果，仅在输入参数return_portrait_location为true时，返回该字段，当输入身份证背面时返回为空列表。
detect_reproduce_result	Boolean	身份证图像是否翻拍告警结果。 true：表示身份证图片经过翻拍。 false：表示身份证图片未经过翻拍。仅在输入参数detect_reproduce为true时，返回该字段。
detect_copy_result	Boolean	身份证图像是否黑白复印件告警结果。 true：表示身份证图片是复印件。 false”表示身份证图片是原件。仅在输入参数detect_copy为true时，返回该字段。
detect_tampering_result	Boolean	身份证图片是否PS告警结果。 true：表示身份证经过PS。 false：表示未经过PS。仅在传入参数detect_tampering为true时，返回该字段。
detect_border_integrity_result	Boolean	身份证图片边框完整性告警结果。 true：表示边框不完整 false：表示边框完整。仅在输入参数detect_border_integrity为true时，返回该字段。
detect_blocking_within_border_result	Boolean	身份证图像框内是否存在遮挡的告警结果。 true：表示边框内部存在遮挡。 false：表示边框内部不存在遮挡。仅在输入参数detect_blocking_within_border为true时，返回该字段。
detect_blur_result	Boolean	身份证模糊告警结果。 true：表示身份证图片较模糊。 false：表示身份证清晰。仅在输入参数detect_blur为true时，返回该字段。
detect_interim_result	Boolean	临时身份证告警结果。 true：表示是临时身份证。 false：表示非临时身份证。仅在输入参数detect_interim为true时，返回该字段。
detect_glare_result	Boolean	身份证反光告警结果。 true：表示身份证图片存在反光。 false：表示是身份证不存在反光。仅在输入参数detect_glare为true时，返回该字段。
score_info	IdcardScoreInfoResult object	告警分数，包含字段：tampering_score、interim_score、reproduce_score、copy_score、border_integrity_score、blur_score、glare_score、blocking_within_border_score，以上字段取值范围为[0, 99]。
front	IdcardFrontResult object	身份证人像面识别结果。仅在输入参数side为double_side时，返回该字典，若未识别到人像面或人像面图片质量太差则该字典为空。
back	IdcardBackResult object	身份证国徽面识别结果。仅在输入参数side为double_side时，返回该字典，若未识别到国徽面或国徽面图片质量太差则该字典为空。

表6 IdcardVerificationResult
参数	参数类型	描述
valid_number	Boolean	身份证号规则校验是否通过。 true：表示身份证号规则校验通过。 false：表示身份证号规则校验不通过。当识别结果为单页，身份证图片是国徽面时，默认是false。输入参数side为double_side时，该字典仅在front字段中存在。仅在输入参数return_verification为true时，返回该字段。
valid_birth	Boolean	出生日期与身份证号所表示的出生日期是否一致。 true：表示一致。 false：表示不一致。当识别结果为单页，身份证图片是国徽面，或者身份证号规则校验不通过时，默认是false。输入参数side为double_side时，该字段仅在front字典中存在。仅在输入参数return_verification为true时，返回该字段。
valid_sex	Boolean	性别与身份证号所表示的性别信息是否一致。 true：表示一致。 false：表示不一致。当识别结果为单页，身份证图片是国徽面，或者身份证号规则校验不通过时，默认是false。输入参数side为double_side时，该字段仅在front字典中存在。仅在输入参数return_verification为true时，返回该字段。
valid_date	Boolean	当前日期是否在有效期内。 true：表示当前日期在有效期内。 false：表示当前日期不在有效期内。当识别结果为单页，身份证图片是人像面时，默认是false。输入参数side为double_side时，该字段仅在back字典中存在。仅在输入参数return_verification为true时，返回该字段。
valid_validity_period	Boolean	身份证有效日期是否合法。 true：表示身份证的有效日期合法 false：表示身份证有效日期非法当识别结果为单页，身份证图片是人像面时，默认是false。输入参数side为double_side时，该字段仅在back字典中存在。仅在输入参数return_verification为true时，返回该字段。

表7 IdcardFrontResult
参数	参数类型	描述
name	String	姓名。
sex	String	性别。
birth	String	出生日期。
ethnicity	String	民族。
address	String	地址。
number	String	身份证号。
portrait_image	String	身份证头像图片信息的base64码结果。说明：仅在输入参数return_portrait_image为true时，返回该字段。当输入为身份证背面时返回为空字符串。
adjusted_image	String	身份证卡面图片信息的base64码结果。说明：仅在输入参数return_adjusted_image为true时，返回该字段。
verification_result	IdcardFrontVerificationResult object	校验信息。仅在输入参数return_verification为true时，返回该字段，该字段包含valid_number、valid_birth和valid_sex的校验信息。
text_location	Object	文本框在原图位置。输出左上、右上、右下、左下四个点坐标。仅return_text_location设置为true时才返回。
portrait_location	Array<Array<Integer>>	身份证头像位置信息的结果。仅在输入参数return_portrait_location为true时，返回该字段。
detect_reproduce_result	Boolean	身份证图像是否翻拍告警结果。 true：表示身份证图片经过翻拍。 false：表示身份证图片未经过翻拍。仅在输入参数detect_reproduce为true时，返回该字段。
detect_copy_result	Boolean	身份证图像是否黑白复印件告警结果。 true：表示身份证图片是复印件。 false”表示身份证图片是原件。仅在输入参数detect_copy为true时，返回该字段。
detect_tampering_result	Boolean	身份证图片是否PS告警结果。 true：表示身份证经过PS。 false：表示未经过PS。仅在传入参数detect_tampering为true时，返回该字段。
detect_border_integrity_result	Boolean	身份证图片边框完整性告警结果。 true：表示边框不完整 false：表示边框完整。仅在输入参数detect_border_integrity为true时，返回该字段。
detect_blocking_within_border_result	Boolean	身份证图像框内是否存在遮挡的告警结果。 true：表示边框内部存在遮挡。 false：表示边框内部不存在遮挡。仅在输入参数detect_blocking_within_border为true时，返回该字段。
detect_blur_result	Boolean	身份证模糊告警结果。 true：表示身份证图片较模糊。 false：表示身份证清晰。仅在输入参数detect_blur为true时，返回该字段。
detect_interim_result	Boolean	临时身份证告警结果。 true：表示是临时身份证。 false：表示非临时身份证。仅在输入参数detect_interim为true时，返回该字段。
detect_glare_result	Boolean	身份证反光告警结果。 true：表示身份证图片存在反光。 false：表示是身份证不存在反光。仅在输入参数detect_glare为true时，返回该字段。
score_info	IdcardScoreInfoResult object	告警分数，包含字段：tampering_score、interim_score、reproduce_score、copy_score、border_integrity_score、blur_score、glare_score、blocking_within_border_score，以上字段取值范围为[0, 99]。

表8 IdcardFrontVerificationResult
参数	参数类型	描述
valid_number	Boolean	身份证号规则校验是否通过。 true：表示身份证号规则校验通过。 false：表示身份证号规则校验不通过。当识别结果为单页，身份证图片是国徽面时，默认是false。输入参数side为double_side时，该字典仅在front字段中存在。仅在输入参数return_verification为true时，返回该字段。
valid_birth	Boolean	出生日期与身份证号所表示的出生日期是否一致。 true：出生日期与身份证号所表示的出生日期一致。 false：出生日期与身份证号所表示的出生日期不一致。当识别结果为单页，身份证图片是国徽面，或者身份证号规则校验不通过时，默认是false。输入参数side为double_side时，该字段仅在front字典中存在。仅在输入参数return_verification为true时，返回该字段。
valid_sex	Boolean	性别与身份证号所表示的性别信息是否一致。 -true：性别与身份证号所表示的性别信息一致 -false：性别与身份证号所表示的性别信息不一致。当识别结果为单页，身份证图片是国徽面，或者身份证号规则校验不通过时，默认是false。输入参数side为double_side时，该字段仅在front字典中存在。仅在输入参数return_verification为true时，返回该字段。

表9 IdcardBackResult
参数	参数类型	描述
issue	String	发证机关。
valid_from	String	有效起始日期。
valid_to	String	有效结束日期。
adjusted_image	String	身份证卡面图片信息的base64码结果。说明：仅在输入参数return_adjusted_image为true时，返回该字段。
verification_result	IdcardBackVerificationResult object	校验信息。仅在输入参数return_verification为true时，返回该字段，该字段包含valid_date和valid_validity_period的校验信息。
text_location	Object	文本框在原图位置。输出左上、右上、右下、左下四个点坐标。仅return_text_location设置为true时才返回。
detect_reproduce_result	Boolean	身份证图像是否翻拍告警结果。 true：表示身份证图片经过翻拍。 false：表示身份证图片未经过翻拍。仅在输入参数detect_reproduce为true时，返回该字段。
detect_copy_result	Boolean	身份证图像是否黑白复印件告警结果。 true：表示身份证图片是复印件。 false”表示身份证图片是原件。仅在输入参数detect_copy为true时，返回该字段。
detect_tampering_result	Boolean	身份证图片是否PS告警结果。 true：表示身份证经过PS。 false：表示未经过PS。仅在传入参数detect_tampering为true时，返回该字段。
detect_border_integrity_result	Boolean	身份证图片边框完整性告警结果。 true：表示边框不完整 false：表示边框完整。仅在输入参数detect_border_integrity为true时，返回该字段。
detect_blocking_within_border_result	Boolean	身份证图像框内是否存在遮挡的告警结果。 true：表示边框内部存在遮挡。 false：表示边框内部不存在遮挡。仅在输入参数detect_blocking_within_border为true时，返回该字段。
detect_blur_result	Boolean	身份证模糊告警结果。 true：表示身份证图片较模糊。 false：表示身份证清晰。仅在输入参数detect_blur为true时，返回该字段。
detect_interim_result	Boolean	临时身份证告警结果。 true：表示是临时身份证。 false：表示非临时身份证。仅在输入参数detect_interim为true时，返回该字段。
detect_glare_result	Boolean	身份证反光告警结果。 true：表示身份证图片存在反光。 false：表示是身份证不存在反光。仅在输入参数detect_glare为true时，返回该字段。
score_info	IdcardScoreInfoResult object	告警分数，包含字段：tampering_score、interim_score、reproduce_score、copy_score、border_integrity_score、blur_score、glare_score、blocking_within_border_score，以上字段取值范围为[0, 99]。

**表10** IdcardBackVerificationResult
参数	参数类型	描述
valid_date	Boolean	当前日期是否在有效期内。 true：表示当前日期在有效期内。 false：表示当前日期不在有效期内。当识别结果为单页，身份证图片是人像面时，默认是false。输入参数side为double_side时，该字段仅在back字典中存在。仅在输入参数return_verification为true时，返回该字段。
valid_validity_period	Boolean	身份证有效日期是否合法。 true：表示身份证的有效日期合法 false：表示身份证有效日期非法当识别结果为单页，身份证图片是人像面时，默认是false。输入参数side为double_side时，该字段仅在back字典中存在。仅在输入参数return_verification为true时，返回该字段。

**表11** IdcardScoreInfoResult
参数	参数类型	描述
tampering_score	Integer	身份证PS告警分数，分数越高，PS的可能性越高。仅在传入参数detect_tampering为true时，返回该字段。
interim_score	Integer	临时身份证告警分数，分数越高，临时身份证的可能性越高。仅在传入参数detect_interim为true时，返回该字段。
reproduce_score	Integer	身份证翻拍告警分数，分数越高，身份证图像经过翻拍的可能性越高。仅在传入参数detect_reproduce为true时，返回该字段。
copy_score	Integer	身份证复印告警分数, 分数越高，身份证图像是复印件的可能性越高。仅在传入参数detect_copy为true时，返回该字段。
border_integrity_score	Integer	身份证边缘完整性告警的分数，分数越高，身份证图像边缘不完整的可能性越高。仅在传入参数detect_border_integrity为true时，返回该字段。
blur_score	Integer	身份证模糊告警分数，分数越高，身份证图像模糊的可能性越高。仅在传入参数detect_blur为true时，返回该字段。
glare_score	Integer	身份证反光告警分数，分数越高，身份证图像存在反光的可能性越高。仅在传入参数detect_glare为true时，返回该字段。
blocking_within_border_score	Integer	身份证图像框内是否有遮挡的告警分数，分数越高，身份证图像框内存在异物遮挡的可能性越高。仅在传入参数detect_blocking_within_border为true时，返回该字段。

状态码： 400

**表12** 响应Body参数
参数	参数类型	说明
error_code	String	调用失败时的错误码，具体请参见错误码。调用成功时不返回此字段。
error_msg	String	调用失败时返回的错误信息。调用成功时不返回此字段。

请求示例

“endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。
例如，身份证识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”，请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/id-card”，“project_id”为项目ID，获取方法请参见获取项目ID。
如何获取Token请参见认证鉴权。

传入身份证图片的base64编码进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件

POST https://{endpoint}/v2/{project_id}/ocr/id-card 
 Request Header:   
 Content-Type: application/json   
 X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...   
 Request Body:
{
  "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...",
  "side" : "front",
  "return_text_location" : true,
  "return_verification" : true,
  "detect_reproduce" : true,
  "detect_copy" : true
}

传入身份证图片的url进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件

POST https://{endpoint}/v2/{project_id}/ocr/id-card
 Request Header:   
 Content-Type: application/json   
 X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...      
 Request Body:
{
  "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName",
  "side" : "front",
  "return_text_location" : true,
  "return_verification" : true,
  "detect_reproduce" : true,
  "detect_copy" : true
}

响应示例

状态码：200

成功响应示例（人像面）

{
  "result" : {
    "name" : "张三",
    "sex" : "男",
    "ethnicity" : "汉",
    "birth" : "2000-03-06",
    "address" : "XX省XX市XX区XX街道XX号",
    "number" : "610XXXXXXXXXXXXXXX",
    "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQAB....",
    "portrait_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD....",
    "detect_reproduce_result" : true,
    "detect_copy_result" : true,
    "verification_result" : {
      "valid_number" : true,
      "valid_birth" : true,
      "valid_sex" : true,
      "valid_date" : false
    }
  }
}

成功响应示例（国徽面）

{
  "result" : {
    "issue" : "XX省XX市XX区XX派出所",
    "valid_from" : "2004-08-26",
    "valid_to" : "2034-08-26",
    "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQAB....",
    "portrait_image" : "",
    "verification_result" : {
      "valid_number" : false,
      "valid_birth" : false,
      "valid_sex" : false,
      "valid_date" : true
    },
    "detect_reproduce_result" : true,
    "detect_copy_result" : true
  }
}

成功响应示例(双面)

{
  "result" : {
    "front" : {
      "name" : "张三",
      "sex" : "男",
      "ethnicity" : "汉",
      "birth" : "1984-27-28",
      "address" : "杭州市xx区xx街xx路xx号",
      "number" : "372901xxxxxxxx4358",
      "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQAB....",
      "portrait_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD....",
      "verification_result" : {
        "valid_number" : true,
        "valid_birth" : false,
        "valid_sex" : true
      },
      "detect_reproduce_result" : true,
      "detect_copy_result" : false,
      "score_info" : {
        "reproduce_score" : 49,
        "copy_score" : 0
      }
    },
    "back" : {
      "issue" : "xx县公安局",
      "valid_from" : "2006-08-30",
      "valid_to" : "2016-08-30",
      "adjusted_image" : "/9j/4AAQSkZJRgABAQAAAQABAAD....",
      "verification_result" : {
        "valid_date" : true,
        "valid_validity_period" : true
      },
      "detect_reproduce_result" : false,
      "detect_copy_result" : false,
      "score_info" : {
        "reproduce_score" : 23,
        "copy_score" : 0
      }
    }
  }
}

状态码：400

失败响应示例

{
    "error_code": "AIS.0103",
    "error_msg": "The image size does not meet the requirements."
}

SDK代码示例

SDK代码示例如下。

使用SDK前建议将SDK更新至最新版，防止本地旧版SDK无法使用最新的OCR功能。

传入身份证图片的base64编码进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件以及返回文字块的区域位置信息

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
import com.huaweicloud.sdk.ocr.v1.*;
import com.huaweicloud.sdk.ocr.v1.model.*;


public class RecognizeIdCardSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OcrClient client = OcrClient.newBuilder()
                .withCredential(auth)
                .withRegion(OcrRegion.valueOf("<YOUR REGION>"))
                .build();
        RecognizeIdCardRequest request = new RecognizeIdCardRequest();
        IdCardRequestBody body = new IdCardRequestBody();
        body.withDetectCopy(true);
        body.withDetectReproduce(true);
        body.withReturnTextLocation(true);
        body.withReturnVerification(true);
        body.withSide("front");
        body.withImage("/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...");
        request.withBody(body);
        try {
            RecognizeIdCardResponse response = client.recognizeIdCard(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

传入身份证图片的url进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件以及返回文字块的区域位置信息

        
         
           
           
             package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.ocr.v1.region.OcrRegion;
import com.huaweicloud.sdk.ocr.v1.*;
import com.huaweicloud.sdk.ocr.v1.model.*;


public class RecognizeIdCardSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        OcrClient client = OcrClient.newBuilder()
                .withCredential(auth)
                .withRegion(OcrRegion.valueOf("<YOUR REGION>"))
                .build();
        RecognizeIdCardRequest request = new RecognizeIdCardRequest();
        IdCardRequestBody body = new IdCardRequestBody();
        body.withDetectCopy(true);
        body.withDetectReproduce(true);
        body.withReturnTextLocation(true);
        body.withReturnVerification(true);
        body.withSide("front");
        body.withUrl("https://BucketName.obs.myhuaweicloud.com/ObjectName");
        request.withBody(body);
        try {
            RecognizeIdCardResponse response = client.recognizeIdCard(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

            

          

        
       

传入身份证图片的base64编码进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件以及返回文字块的区域位置信息

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkocr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = OcrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OcrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizeIdCardRequest()
        request.body = IdCardRequestBody(
            detect_copy=True,
            detect_reproduce=True,
            return_text_location=True,
            return_verification=True,
            side="front",
            image="/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
        )
        response = client.recognize_id_card(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

传入身份证图片的url进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件以及返回文字块的区域位置信息

        
         
           
           
             # coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkocr.v1.region.ocr_region import OcrRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkocr.v1 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.getenv("CLOUD_SDK_AK")
    sk = os.getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = OcrClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(OcrRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = RecognizeIdCardRequest()
        request.body = IdCardRequestBody(
            detect_copy=True,
            detect_reproduce=True,
            return_text_location=True,
            return_verification=True,
            side="front",
            url="https://BucketName.obs.myhuaweicloud.com/ObjectName"
        )
        response = client.recognize_id_card(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

            

          

        
       

传入身份证图片的base64编码进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件以及返回文字块的区域位置信息

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := ocr.NewOcrClient(
        ocr.OcrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizeIdCardRequest{}
	detectCopyIdCardRequestBody:= true
	detectReproduceIdCardRequestBody:= true
	returnTextLocationIdCardRequestBody:= true
	returnVerificationIdCardRequestBody:= true
	sideIdCardRequestBody:= "front"
	imageIdCardRequestBody:= "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
	request.Body = &model.IdCardRequestBody{
		DetectCopy: &detectCopyIdCardRequestBody,
		DetectReproduce: &detectReproduceIdCardRequestBody,
		ReturnTextLocation: &returnTextLocationIdCardRequestBody,
		ReturnVerification: &returnVerificationIdCardRequestBody,
		Side: &sideIdCardRequestBody,
		Image: &imageIdCardRequestBody,
	}
	response, err := client.RecognizeIdCard(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

传入身份证图片的url进行文字识别，并对身份证号进行规则校验，同时判断身份证是否为翻拍、复印件以及返回文字块的区域位置信息

        
         
           
           
             package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := ocr.NewOcrClient(
        ocr.OcrClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.RecognizeIdCardRequest{}
	detectCopyIdCardRequestBody:= true
	detectReproduceIdCardRequestBody:= true
	returnTextLocationIdCardRequestBody:= true
	returnVerificationIdCardRequestBody:= true
	sideIdCardRequestBody:= "front"
	urlIdCardRequestBody:= "https://BucketName.obs.myhuaweicloud.com/ObjectName"
	request.Body = &model.IdCardRequestBody{
		DetectCopy: &detectCopyIdCardRequestBody,
		DetectReproduce: &detectReproduceIdCardRequestBody,
		ReturnTextLocation: &returnTextLocationIdCardRequestBody,
		ReturnVerification: &returnVerificationIdCardRequestBody,
		Side: &sideIdCardRequestBody,
		Url: &urlIdCardRequestBody,
	}
	response, err := client.RecognizeIdCard(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

            

          

        
       

更多编程语言的SDK代码示例，请参见API Explorer的代码示例页签，可生成自动对应的SDK代码示例。

状态码

状态码	描述
200	成功响应示例
400	失败响应示例

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： API

上一篇：印章识别

下一篇：户口本识别

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

身份证识别

功能介绍

约束与限制

调用方法

前提条件

URI

请求参数

响应参数

请求示例

响应示例

SDK代码示例

状态码

错误码

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线