H5接口文档
所有文档

          人脸识别

          H5接口文档

          本文档为您提供了H5端的实名认证接口文档,您可以基于此接口进行业务信息的二次开发及查询操作。

          获取Token

          1、获取verify_token接口

          本接口为H5实名认证方案的verify_token获取接口

          token有效期为2小时

          调用方式

          请求URL数据格式

          向API服务地址使用POST发送请求,必须在URL中带上参数access_token,可通过后台的API Key和Secret Key生成,具体方式请参考“Access Token获取”。

          注意access_token的有效期为30天,切记需要每30天进行定期更换,或者每次请求都拉取新token

          POST中Body的参数,按照下方请求参数说明选择即可。

          提示:如果您为百度云老用户,正在使用其他非AI的服务,可以参考百度云AKSK鉴权方式发送请求,虽然请求方式鉴权方法和本文所介绍的不同,但请求参数和返回结果一致。

          请求说明

          注意事项

          • 请求体格式化:Content-Type为application/json,通过json格式化请求体。

          请求示例

          HTTP方法:POST

          请求URL: https://aip.baidubce.com/rpc/2.0/brain/solution/faceprint/verifyToken/generate

          URL参数:

          参数
          access_token 通过API Key和Secret Key获取的access_token,参考“Access Token获取

          Header:

          参数
          Content-Type application/json

          Body中放置请求参数,参数详情如下:

          请求参数

          参数 必选 类型 说明
          plan_id string 方案的id信息,请在人脸实名认证控制台查看创建的H5方案的方案ID信息

          请求示例:

          {
          	"plan_id" : 1
          }

          返回参数

          • 返回结果
          字段 必选 类型 说明
          success boolean 返回请求是否成功信息。
          若请求成功返回ture;
          请求失败则返回fault
          result array 请求结果
          +verify_token string 请求获取的verify_token
          • 返回示例

            {
                "success": true,
                "result": {
                    "verify_token": "Yz9rWITm4vak16PBAh5x8oG7"
                },
                "log_id": "1814798895"
            }

          指定用户信息上报接口

          本接口用于,前端在方案中选择身份信息录入-身份信息录入方式-指定用户身份核验时,需要先调用此接口输入指定用户的姓名+身份证号信息,再请求url跳转页面。

          调用方式

          请求URL数据格式

          向API服务地址使用POST发送请求,必须在URL中带上参数access_token,可通过后台的API Key和Secret Key生成,具体方式请参考“Access Token获取”。

          注意access_token的有效期为30天,切记需要每30天进行定期更换,或者每次请求都拉取新token

          POST中Body的参数,按照下方请求参数说明选择即可。

          提示:如果您为百度云老用户,正在使用其他非AI的服务,可以参考百度云AKSK鉴权方式发送请求,虽然请求方式鉴权方法和本文所介绍的不同,但请求参数和返回结果一致。

          请求说明

          注意事项

          • 请求体格式化:Content-Type为application/json,通过json格式化请求体。

          请求示例

          HTTP方法:POST

          请求URL:https://brain.baidu.com/solution/faceprint/idcard/submit

          注意这里不需要传access_token

          Header:

          参数
          Content-Type application/json

          Body中放置请求参数,参数详情如下:

          参数 必选 类型
          verify_token string 通过access_token获取的verify_token
          id_name string 指定输入用户的姓名信息
          id_no string 指定输入用户的身份证件号信息
          certificate_type Int 证件类型:
          0大陆居民二代身份证
          1港澳台居民来往内地通行证
          2外国人永久居留证
          3定居国外的中国公民护照

          请求示例:

          {
              "verify_token": "2sF3nE5mXOHkx2aQwWG4n5WI",
              "id_name": "张三",
              "id_no": "500***********3390",
              "certificate_type": 0            // 证件类型:0大陆居民二代身份证,1港澳台居民来往内地通行证,2外国人永久居留证,3定居国外的中国公民护照
          }

          返回参数

          • 返回结果
          字段 必选 类型 说明
          success boolean 返回请求是否成功信息。
          若请求成功返回ture;
          请求失败则返回fault
          result array 请求结果,返回固定结果1,可忽略
          • 返回示例

            {
                "success": true,
                "result": 1,
                "log_id": "1244068892"
            }
          ## 验证后查询接口
          
          > 获取Token后,请先按照[跳转实名认证H5 URL](https://ai.baidu.com/ai-doc/FACE/rknovx7ce#step4:跳转实名认证h5-url,用户进行操作),用户进行操作后再查询接口,否则生成Token无法生效。
          
          ### 1、获取认证人脸接口
          
           本接口返回进行人脸实名认证过程中进行认证的最终采集的人脸信息。
          
          #### 调用方式
          
          **请求URL数据格式**
          
          向API服务地址使用POST发送请求,必须在URL中带上参数`access_token`,可通过后台的API Key和Secret Key生成,具体方式请参考“[Access Token获取](http://ai.baidu.com/docs#/Auth)”。
          
          > **注意**:`access_token`的有效期为30天,**切记需要每30天进行定期更换,或者每次请求都拉取新token**;
          
          POST中Body的参数,按照下方请求参数说明选择即可。
          
          > **提示**:如果您为百度云老用户,正在使用其他非AI的服务,可以参考[百度云AKSK鉴权方式](https://cloud.baidu.com/doc/Reference/AuthenticationMechanism.html)发送请求,虽然**请求方式**和**鉴权方法**和本文所介绍的不同,但请求参数和返回结果一致。
          
          #### 请求说明
          
          **注意事项**:
          
          * **请求体格式化**:Content-Type为`application/json`,通过`json`格式化请求体。
          
          **请求示例**
          
          HTTP方法:`POST`
          
          请求URL: `https://aip.baidubce.com/rpc/2.0/brain/solution/faceprint/result/simple`
          
          URL参数:
          
          | 参数         | 值                                                           |
          | ------------ | ------------------------------------------------------------ |
          | access_token | 通过API Key和Secret Key获取的access_token,参考“[Access Token获取](http://ai.baidu.com/docs#/Auth/top)” |
          
          Header:
          
          | 参数         | 值               |
          | ------------ | ---------------- |
          | Content-Type | application/json |
          
          Body中放置请求参数,参数详情如下:
          
          | 参数         | 值               |
          | ------------ | ---------------- |
          | verify_token | 通过access_token获取的verify_token |
          
          请求示例:
          
          ~~~
          {
          	"verify_token" : "cIupeyP51sn28XzxGVTfYqoN"
          }
          ~~~
          
          **返回参数**
          
          - 返回结果
          
          | 字段    | 必选 | 类型   | 说明                                                         |
          | ------- | ---- | ------ | ------------------------------------------------------------ |
          | success | 是   | boolean    | 返回请求是否成功信息。<Br>若请求成功返回ture;<Br>请求失败则返回fault |
          | result  | 是   | array  | 请求结果                                                     |
          | +image  | 是   | string | 返回采集的用户人脸信息                                       |
          
          
          - 返回示例
          
           ```json
           {
               "success": true,
               "result": {
                   "image": "https://bj.bcebos.com/face-solution?authorization=XXXX"
               },
               "log_id": "1054986003"
           }
           

          2、查询认证结果接口

          本接口为请求返回的认证结果信息查询,包含身份证OCR识别信息、用户二次确认的身份证信息,活体检测信息、及用户对权威数据源图片进行比对的分数信息。

          调用方式

          请求URL数据格式

          向API服务地址使用POST发送请求,必须在URL中带上参数access_token,可通过后台的API Key和Secret Key生成,具体方式请参考“Access Token获取”。

          注意access_token的有效期为30天,切记需要每30天进行定期更换,或者每次请求都拉取新token

          POST中Body的参数,按照下方请求参数说明选择即可。

          提示:如果您为百度云老用户,正在使用其他非AI的服务,可以参考百度云AKSK鉴权方式发送请求,虽然请求方式鉴权方法和本文所介绍的不同,但请求参数和返回结果一致。

          请求说明

          注意事项

          • 请求体格式化:Content-Type为application/json,通过json格式化请求体。

          请求示例

          HTTP方法:POST

          请求URL: https://aip.baidubce.com/rpc/2.0/brain/solution/faceprint/result/detail

          URL参数:

          参数
          access_token 通过API Key和Secret Key获取的access_token,参考“Access Token获取

          Header:

          参数
          Content-Type application/json

          Body中放置请求参数,参数详情如下:

          参数
          verify_token 通过access_token获取的verify_token

          请求示例:

          {
          	"verify_token" : "cIupeyP51sn28XzxGVTfYqoN"
          }

          返回参数

          • 返回结果
          字段 必选 类型 说明
          success boolean 返回请求是否成功信息。
          若请求成功返回ture;
          请求失败则返回fault
          result array 请求结果
          +idcard_ocr_result array 返回采集的用户人脸信息
          当人脸实名认证控制台设置为使用OCR识别时返回此参数信息
          ++address string 地址
          ++birthday string 生日
          ++name string 姓名
          ++id_card_number string 身份证号
          ++gender string 性别
          ++nation string 民族
          ++expire_time string 身份证失效日期
          ++issue_authority string 身份证签发机关
          ++issue_time string 身份证生效日期
          +idcard_images array 返回采集的身份证图片信息
          当人脸实名认证控制台设置为使用OCR识别时返回此参数信息
          ++front_base64 string 身份证图片的正面信息
          ++back_base64 string 身份证图片的反面信息
          当人脸实名认证控制台设置为使用OCR识别且为国徽面+人像面时返回此参数信息
          +verify_result array 认证返还信息
          ++liveness_score string 活体检测分数
          ++score string 人脸实名认证
          ++spoofing string 合成图分数
          若未进行合成图检测,则返回0
          若进行活体检测,则返回合成图检测分值
          +idcard_confirm array 用户二次确认的身份证信息
          ++name string 姓名
          ++idcard_number string 身份证号
          • 返回示例

            {
              "success": true,
              "result": {
                  "verify_result": {
                      "score": 93.7835,
                      "liveness_score": 0.9672966,
                      "spoofing": 0.0
                  },
                  "idcard_ocr_result": {
                      "birthday": "19960216",
                      "issue_authority": "胶南市公安局",
                      "address": "山东省***********",
                      "gender": "女",
                      "nation": "汉",
                      "expire_time": "20221103",
                      "name": "柴*",
                      "issue_time": "20121103",
                      "id_card_number": "370***********5826"
                  },
                  "idcard_images": {
                      "front_base64": "/9j/4AAQSkZJRgAB....",
                      "back_base64": "/9j/4AAQSkZJRgAB...."
               },
                  "idcard_confirm": {
                      "idcard_number": "370***********5826",
                      "name": "柴*"
                  }
              },
              "log_id": "160931948204246"
            }

          3、查询统计结果

          本接口返回了对当前Verify_token信息的统计结果的查询,有效期为三天。

          调用方式

          请求URL数据格式

          向API服务地址使用POST发送请求,必须在URL中带上参数access_token,可通过后台的API Key和Secret Key生成,具体方式请参考“Access Token获取”。

          注意access_token的有效期为30天,切记需要每30天进行定期更换,或者每次请求都拉取新token

          POST中Body的参数,按照下方请求参数说明选择即可。

          提示:如果您为百度云老用户,正在使用其他非AI的服务,可以参考百度云AKSK鉴权方式发送请求,虽然请求方式鉴权方法和本文所介绍的不同,但请求参数和返回结果一致。

          请求说明

          注意事项

          • 请求体格式化:Content-Type为application/json,通过json格式化请求体。

          请求示例

          HTTP方法:POST

          请求URL: https://aip.baidubce.com/rpc/2.0/brain/solution/faceprint/result/stat

          URL参数:

          参数
          access_token 通过API Key和Secret Key获取的access_token,参考“Access Token获取

          Header:

          参数
          Content-Type application/json

          Body中放置请求参数,参数详情如下:

          参数
          verify_token 通过access_token获取的verify_token

          请求示例:

          {
          	"verify_token" : "cIupeyP51sn28XzxGVTfYqoN"
          }

          返回参数

          • 返回结果
          字段 必选 类型 说明
          success boolean 返回请求是否成功信息。
          若请求成功返回ture;
          请求失败则返回fault
          result array 请求结果
          +身份证识别 array 身份证识别接口请求的统计信息
          ++error_code string 错误码编号
          若为0则表示请求成功
          ++count int 当前错误码的请求数量
          +h5活体视频分析 array h5活体视频分析接口请求的统计信息
          ++error_code string 错误码编号
          若为0则表示请求成功
          ++count int 当前错误码的请求数量
          +人脸实名认证-V3 array 人脸实名认证-V3接口请求的统计信息
          ++error_code string 错误码编号
          若为0则表示请求成功
          ++count string 当前错误码的请求数量
          • 返回示例

            {
                "success": true,
                "result": {
                    "身份证识别": [
                        {
                            "error_code": 0,
                            "count": 2
                        }
                    ],
                    "h5活体视频分析": [
                        {
                            "error_code": 0,
                            "count": 1
                        }
                    ],
                    "人脸实名认证-V3": [
                        {
                            "error_code": 0,
                            "count": 1
                        }
                    ]
                },
                "log_id": "1405335905"
            }
          上一篇
          创建项目及方案
          下一篇
          标准级APP端实名认证方案