接入文档
FaceID高级版
H5接入
API调用
获取比对结果
获取比对结果

# 调用URL

GET https://api.megvii.com/faceid/lite/get_result

注意：在生产环境中，请使用HTTPS的通信方式。HTTP方式的通信属于不安全链路，存在安全风险，请勿在生产环境中使用。在生产环境中使用HTTP方式的，将无法得到服务可靠性保障。

说明：此接口提供活体结果反查功能，可以以biz_id为索引对 FaceID H5验证结果进行反查。该接口的调用信息保存有效期为一天，且仅支持3次调用。第4次或超过有效期调用则会返回错误信息，建议在每笔业务结束之后及时的取回数据。

# 参数

必选／可选 参数 类型 参数说明
必选 api_key String 调用此API的api_key
必选 api_secret String 调用此API的api_key的secret
必选 biz_id String 通过get_token, notify_url或者return_url返回的活体业务编号
可选 return_verify_time String 该参数用于控制验证发生时间信息的返回  0（默认）：不返回做验证发生的时间 1：需要返回验证发生的时间 
可选 return_image String 此参数为可选参数，可在下面5种参数中选择，决定了是否返回活体图像数据：
  • 0（默认）：不需要图像
  • 1：需要返回最佳活体质量图(image_best）
  • 2：需要返回身份证人像面图像
  • 3：需要返回身份证国徽面图像
  • 4：需要返回所有图像

# 返回值说明

参数 类型 说明 示例
request
_id 		String API 调用的流水号 "1462259763,
e2d2f8d6-204b-4c43
-92ea-1d62b071f83c"
status String 此字段仅表示当前FaceID H5验证流程是否正常结束，非人脸核验结果。
活体检测结果查看liveness_result字段，人脸比对结果查看verify_result字段，意愿验证结果查看will_result字段。
  • NOT_STARTED：get_token 之后，并没有调用过do方法，还没有开始验证
  • PROCESSING：正在进行FaceID Lite验证
  • WEBRTC_UNSUPPORTED：表示浏览器不支持引起失败
  • OK：完成了FaceID Lite验证（OK并不表示通过了验证，是流程正常结束）
  • FAILED：验证流程未完成或出现异常
  • CANCELLED：用户主动取消了验证流程
  • TIMEOUT：流程超时
"OK"
fail
_reason 		String 当“get_fail_reason”=1时，可获取“WEBRTC_UNSUPPORTED”失败原因
  • NETWORK_ERROR：因为网络问题无法连接
  • PERMISSIONS_ERROR ：用户拒绝摄像头权限或浏览器（APP）不支持唤起摄像头权限
  • SUPPORT_ERROR：浏览器不支持webRTC API 等
“NETWORK_ERROR”
biz_info Json 包含：biz_id, biz_no, biz_extra_data
  • biz_id：业务流串号，可以用于反查比对结果
  • biz_no：客户业务流水号，会在notify和return时原封不动的返回给客户
  • biz_extra_data：在调用 notify_url 和 return_url 时会返回的额外数据
用户可以用此接口来传递一些额外信息。 		{
 "biz_extra_data": "...",
 "biz_id": "1462259748,
 52b13fb5-8dfb-4537
 -a62b-a641d5e929f1",
 "biz_no":
 "cc47190f-5502-44a2
 -ab74-ea4f0f649f61"
}
time
_used 		Int 整个请求所花费的时间，单位为毫秒，此字段必定返回 100
idcard
_info 		Json 身份证识别的结果，此字段在idcard_mode = 0时不返回；如果用户中途中断了活体流程，则此字段也不返回 内容包括：
  • idcard_mode：表示get_token时选择的idcard_mode
  • idcard_uneditable_field：表示get_token是选择的idcard_uneditable_field
  • idcard_mode_user：该字段仅在idcard_mode=4时返回，表示用户选择的身份证信息录入模式
    • 0：选择手输身份证信息
    • 1：选择拍摄身份证人像面
  • idcard_number：表示最终经过用户确认的身份证号 （根据idcard_uneditable_field可能被修改过）
  • idcard_name：表示最终经过用户确认的姓名 （根据idcard_uneditable_field可能被修改过）
  • idcard_valid_date：表示最终经过用户确认的身份证有效期 （根据idcard_uneditable_field可能被修改过，如果不用拍摄身份证国徽面则不返回此字段）  
  • idcard_issued_by：表示最终经过用户确认的身份证签发机关
    （根据idcard_uneditable_field可能被修改过，如果不用拍摄身份证国徽面则不返回此字段）
  • front_side：身份证人像面的识别结果（如果不用拍摄身份证人像面则不返回此字段）
    • ocr_result：文字识别结果，详见【FaceID Ocridcard API】
    • upload_times：在FaceID Lite 人脸核身流程中身份证人像面上传的次数
  • back_side：身份证国徽面的识别结果（如果不用拍摄身份证国徽面则不返回此字段）
    • ocr_result：文字识别结果，详见【FaceID Ocridcard API】
    • upload_times：在FaceID Lite 人脸核身流程中身份证国徽面上传的次数
  • ocr_front_quality：身份证人像面各字段质量判断及逻辑判断结果（该字段仅在lite2.0下进行返回）
  • ocr_back_quality：身份证国徽面各字段质量判断及逻辑判断结果（该字段仅在lite2.0下进行返回）
{
 "idcard_mode": "1",
 "idcard_uneditable_field":  "idcard_number,
 idcard_valid_date",
 "idcard_number":   "xxxxxx19910602xxxx",
 "idcard_name": "陈AB",
 "idcard_valid_date":
   "2010.11.13-2020.11.13",
 "idcard_issued_by":
 "北京市公安局",
 "front_side": {
  "ocr_result": {
   "address":
   "北京市海淀区XXXX",
  "birthday": {
   "day": "2",
   "month": "6",
   "year": "1991"
  },
   "gender": "男",
   "id_card_number":
   "xxxxxx19910602xxxx",
   "name": "陈XX",
   "race": "汉",
  "legality": {
   "ID Photo": 0.855,
   "Temporary
   ID Photo ":0,
   "Photocopy": 0.049,
   "Screen": 0.096,
   "Edited": 0
   }
  },
  "upload_times": 1
 },
 "back_side": {
  "ocr_result": {
   "issued_by": "
   北京市公安局海淀分局",
   "valid_date":
   "2010.11.13-2020.11.13",
  "legality": {
   "ID Photo": 0.855,
   "Temporary ID Photo ": 0,
   
   "Photocopy": 0.049,
   "Screen": 0.096,
   "Edited": 0
  }
  },
  "upload_times": 2
 },
 "ocr_front_quality": {
  "gender": {
   "quality": 0.925,
   "logic": 0,
   "result": "男"
  },
  "address": {
   "quality": 0.958,
   "logic": 0,
   "result": "xxx" },
  "idcard_number": {
   "quality": 0.995,
   "logic": 0,
   "result":
   "xxxx"
 },
  "name": {
   "quality": 0.996,
   "logic": 0,
   "result": "张三"
  },
  "birth_month": {
   "quality": 0.971,
   "logic": 0,
   "result": "8"
  },
  "birth_day": {
   "quality": 0.975,
   "logic": 0,
   "result": "31"
  },
  "nationality": {
   "quality": 0.959,
   "logic": 0,
   "result": "汉"
  },
  "birth_year": {
   "quality": 0.942,
   "logic": 0,
   "result": "1996"
  }
 },
 "ocr_back_quality": {
  "issued_by": {
   "quality": 0.994,
   "logic": 0,
   "result": "xxxxx"
  },
  "valid_date_end": {
   "quality": 0.995,
   "logic": 0,
   "result": "xxxx"
  },
  "valid_date_start": {
   "quality": 0.995,
   "logic": 0,
   "result": "20140515"
  }
 } }
liveness
_result 		Json 活体检测结果；如果用户中途中断了活体流程，则此字段不返回
  • result：活体检测的结果，返回值分为两类：
    • PASS：活体检测通过
    • FAIL：活体检测失败
  • procedure_type：返回本次活体所使用的活体验证方式：
    • will：通过意愿确认方式进行活体验证
  • details：活体检测结果的细节：
  • 当procedure_type取值为"will"时：
    • FACE_NOT_FOUND：<未检测到人脸次数>
    • SIDE_FACE：<未正对摄像头次数（侧脸）>
    • UPDOWN_FACE：<未正对摄像头次数（仰脸或低头）>
    • EYE_OCCLUSION：<遮挡眼部次数>
    • MOUTH_OCCLUSION：<遮挡嘴部次数>
    • AWAY_FROM_CAMERA：<过于远离摄像头次数>
    • CLOSE_TO_CAMERA：<过于靠近摄像头次数>
    • FACE_OUT_OF_CAMERA：<未正视摄像头次数>
    • HIGH_BRIGHTNESS：<光线过亮的次数>
    • LOW_BRIGHTNESS：<光线过暗的次数>
    • LOW_FACE_QUALITY：<视频中人脸质量太差的次数>
  • face_genuineness：表示对假脸攻击的判定，它包含四组置信度和阈值，均为实数取值［0，1］区间。如果一个置信度大于其对应的阈值，则可以认为存在对应类型的假脸攻击
    • synthetic_face_confidence：<合成脸的置信度>
    • synthetic_face_threshold：<合成脸的阈值>
    • mask_confidence：<面具的置信度>
    • mask_threshold：<面具的阈值>
    • screen_replay_confidence：<屏幕翻拍的置信度>
      • screen_replay_threshold：<屏幕翻拍的阈值>
    		• {
    "result": "PASS/FAIL",
    "procedure_type": "will",
    "details": {
     "UPLOAD_TIMES": 5,
     "FACE_NOT
     _FOUND": 0,
     "LOW_FACE
     _QUALITY": 0,
     "INVALID_VIDEO
     _DURATION": 1,
     "SR_ERROR": 2,
     "NOT_SYNCHRONIZED":
     1,
     "VIDEO_FORMAT
     _UNSUPPORTED": 0,
     "NO_AUDIO": 0
    },
    "face_genuineness": {
     "synthetic_face
     _confidence": 0.88,
     "synthetic_face
     _threshold": 0.5,
     "mask_confidence": 0.32,
     "mask_threshold": 0.5,
     "screen_replay
     _confidence": 0,
     "screen_replay
     _threshold": 0.5
    } }
    verify
    _result     		Json 人脸比对结果；如果用户中途中断了活体流程，则此字段不返回
    • error_message：在做人脸比对的时候出现错误
      • null：表示没有出现错误
      • NO_SUCH_ID_NUMBER：没有此身份证号码的记录。此错误会产生计费
      • ID_NUMBER_NAME_NOT_MATCH：身份证号码与提供的姓名不匹配。此错误会产生计费
      • IMAGE_ERROR_UNSUPPORTED_FORMAT: 姓名和身份证号正确，但图片无法解析或者没有可比对图片。此错误会产生计费
      • NO_FACE_FOUND：对应的图像没有检测到人脸。此错误会产生计费
      • DATA_SOURCE_ERROR：调用比对数据发生错误，一般来说是数据出错。出现此错误时建议停止业务，并立即联系FaceID客服或商务，待确认后再开启业务
      • INTERNAL_ERROR：服务器内部错误，当此类错误发生时请再次请求，如果持续出现此类错误，请及时联系FaceID客服或商务
    • result_faceid：人脸核身的综合分数
      • "confidence"：综合分数的置信度，Float类型，取值［0，100］，数字越大表示风险越小
      • “thresholds”：一组用于参考的置信度阈值，Object类型， 包含四个字段，均为Float类型、取值［0，100］：
        • “1e-3”：风险为千分之一的置信度阈值
        • “1e-4”：风险为万分之一的置信度阈值
        • “1e-5”：风险为十万分之一的置信度阈值 
        • “1e-6”：风险为百万分之一的置信度阈值
    • result_ref[x]：活体采集人像与上传的image_ref[x]的比对结果（同result_faceid）
    • result_idcard_photo：活体采集人像与身份证照片上的人脸比对的结果（同result_faceid）
    • result_idcard_datasource：身份证照片上的人脸和参考比对数据照片比对的结果（同result_faceid）
    • id_exceptions：
      • 返回人脸核身相关的异常情况，如证件号码是否曾被冒用来攻击FaceID活体检测等问题。调用者可通过此对象增进对比对结果的解读 本对象仅在人脸核身时（comparison_type == 1)返回，返回包含如下字段：
        • "id_attacked"：Int类型，判别证件号码是否曾被冒用来攻击FaceID活体检测， 取值1表示曾被攻击、取值0表示未被攻击。攻击形态包括但不限于戴面具、换人 攻击、软件3D合成人脸等手段。若被判别为“是”，则有可能这个身份证号码目前 存在被利用的风险。注意：判别为“是”不意味证件持有者本人参与攻击，有可能 其证件被他人盗用而本人无感知
        • "id_photo_monochrome"：Int类型，参考照片的色彩判断，取值1表示 是黑白照片、取值0表示是彩色照片。参考数据存在一部分人像照片是黑白的现象， 黑白的照片会影响比对质量，一般来说将降低比对分数。本字段表达这样的异常
        • verify_time：验证发生的时间戳（单位：秒），仅当return_verify_time=1时返回该字段
    		{
    "verify_time": 1462259763,
    "result_faceid": {
     "confidence": 68.918,
     "thresholds": {
      "1e-3": 64,
      "1e-4": 69,
      "1e-5": 74,
      "1e-6": 79.9
     }
    },
    "result_ref1": {
     "confidence": 68.918,
     "thresholds": {
      "1e-3": 64,
      "1e-4": 69,
      "1e-5": 74,
      "1e-6": 79.9
     }
    },
    "result_idcard_photo": {
     "confidence": 68.918,
     "thresholds": {
      "1e-3": 64,
      "1e-4": 69,
      "1e-5": 74,
      "1e-6": 79.9
     }
    },
    "result_idcard
     _datasource": {
     "confidence": 68.918,
     "thresholds": {
      "1e-3": 64,
      "1e-4": 69,
      "1e-5": 74,
      "1e-6": 79.9
     }
    },
    "id_exceptions": {
     "id_attacked": 0,
     "id_photo_
     monochrome": 0
     }
    }
    images Json 活体检测得到的图像，调用时通过 return_image 来选择，或以jpg编码并用base64字符串返回，或返回为null； 当活体验证通过，存在比对结果且比对结果中error_message为计费字段时，图像才会返回
    • image_best：质量最佳的活体图像
    • image_idcard_back：最后一次上传的身份证国徽面
    • image_idcard_front：最后一次上传的身份证人像面
    注意：
    • return_image为1返回：image_best
    • return_image为2返回：image_idcard_front
    • return_image为3返回：image_idcard_back
    • return_image为4可能返回：image_best、image_idcard_front、image_idcard_back、image_face_front、image_face_side 中一个或多个
    		{
     "image_idcard_back":
     "data:image/jpeg;
     base64,...",
     "image_idcard_front":
     "data:image/jpeg;
     base64,...",
     "image_best":
     "data:image/jpeg;
     base64,..."
    }
    will_result Json 意愿活体结果；未开通意愿核身高级版、意愿比对高级版SKU或不为will，则此字段不返回
    • result：意愿认证问答的结果
      • PASS：意愿认证通过
      • FAIL：意愿认证失败
    • will_error_message：在意愿确认时出现的错误
      • ANSWER_INCONSISTENT：意愿表达与标准答案不一致
      • NO_AUDIO：问答模式用户回答音频无声音
      • MOUTH_NOT_OPEN：问答模式用户回答时未张嘴
      • FUNASR_ERR：语音识别服务异常
      • ACTION_FAIL：点头模式动作检测失败
      • NOT_STARTED：未开始当前问题的意愿认证
    		通过
    "will_result": [
      { "will_error_message": "",
       "result": "PASS"
      }]
    失败"
    will_result": [
      { "result": "FAIL",
       "will_error_message": "ACTION_FAIL"
      }]
    will_file Json 意愿活体问答明细；未开通意愿核身高级版、意愿比对高级版SKU或不为will，则此字段不返回；
    当will_type = 0时，返回以下字段：
    • will_video：意愿认证完整视频下载地址：从进入活体流程 到流程结束
    • will_audio：意愿认证完整音频下载地址：从进入活体流程 到流程结束
    • will_audio_details：返回本次意愿认证所有意愿问答音频及相关信息明细
      • question_audio：意愿认证问题播报的音频文件下载地址
      • user_audio：意愿认证用户回答的音频文件下载地址
      • question_text：问题播报文本信息
      • stand_answer：标准答案文本信息
      • user_text：识别结果文本信息
    当will_type = 1时，返回以下字段：
    • will_video：意愿认证完整视频下载地址：从进入活体流程 到流程结束
    • will_audio_details：返回本次意愿认证相关信息明细
      • question_audio：意愿认证问题播报的音频文件下载地址
      • question_text：问题播报文本信息
  • 下载地址返回说明
    • 可下载有效期1天，且仅支持3次调用。第4次或超过有效期调用则会返回错误信息，建议在每笔业务结束之后及时的取回数据。
    • 如果未收到notify回调或者下载地址未生成等场景调取get_result接口，下载地址会返回空字符串
  • 地址下载请求说明
    • 仅白名单中IP可访问（请联系我方人员）
    • 入参：请用get的方式进行请求
    • 出参：一个加密文件，解密后获取相应文件
  • 加解密说明
    • 加密方式：对称加密 AES-ECB 32位；
    • 加密秘钥：取api_secret前32位作为加密密钥，正常secret长度为32位，如果长度不够则用空格进行补位；
    • 加密内容：数据前1024位，若不足则空格补位；将加密后的数据替换数据的前1024位；
    		• {
     "will_file": {
     "will_video": "xxx",
      "will_audio": "xxx",
      "will_audio_details": [ {
       "user_audio": "xxx",
       "user_text": "我同意",
       "question_text": "您好，为确保您本人操作，此次签约全程录音录像。请问您本次业务是本人自愿办理吗？请回答:我同意",
       "question_audio": "xxx",
       "standard_answer": "我同意" } ]
    }
    multifaces_tag String 仅当return_multifaces_tag参数为1时，返回此字段
    • 0：单人脸
    • 1：多人脸
    		0
    multifaces_image String 如果multifaces_tag=1，则返回一张包含多人脸的图像，以jpg编码并用base64字符串返回；
    如果multifaces_tag=0，则返回空     		"data:image/jpeg;base64,..."

    成功示例

    {
    "request_id": "1462259763,e2d2f8d6-204b-4c43-92ea-1d62b071f83c",
    "status": "OK",
    "biz_info": {
        "biz_extra_data": "...",
        "biz_id": "1462259748,52b13fb5-8dfb-4537-a62b-a641d5e929f1",
        "biz_no": "cc47190f-5502-44a2-ab74-ea4f0f649f61"
    },
    "idcard_info": {
        "idcard_mode": "1",
        "idcard_uneditable_feild": "idcard_number,idcard_valid_date",
        "idcard_number": "xxxxxx19910602xxxx",
        "idcard_name": "陈AB",
        "idcard_issued_by": "北京市公安局",
        "front_side": {
            "ocr_result": {
                "address": "北京市海淀区XXXX",
                "birthday": {
                    "day": "2",
                    "month": "6",
                    "year": "1991"
                },
                "gender": "男",
                "id_card_number": "xxxxxx19910602xxxx",
                "name": "陈XX",
                "race": "汉",
                "legality": {
                    "ID Photo": 0.855,
                    "Temporary ID Photo ": 0,
                    "Photocopy": 0.049,
                    "Screen": 0.096,
                    "Edited": 0
                }
            },
            "upload_times": 1
        },
        "back_side": {
            "ocr_result": {
                "issued_by": "北京市公安局海淀分局",
                "valid_date": "2010.11.13-2020.11.13",
                "legality": {
                    "ID Photo": 0.855,
                    "Temporary ID Photo ": 0,
                    "Photocopy": 0.049,
                    "Screen": 0.096,
                    "Edited": 0
                }
            },
            "upload_times": 2
        }
    },
    "liveness_result": {
        "procedure_type": "will",
        "result": "PASS/FAIL/TIMEOUT",
        "details": {
            "UPLOAD_TIMES": 5,
            "FACE_NOT_FOUND": 0,
            "LOW_FACE_QUALITY": 0,
            "INVALID_VIDEO_DURATION": 1,
            "SR_ERROR": 2,
            "NOT_SYNCHRONIZED": 1,
            "VIDEO_FORMAT_UNSUPPORTED": 0,
            "NO_AUDIO": 0
        },
        "face_genuineness": {
            "synthetic_face_confidence": 0.88,
            "synthetic_face_threshold": 0.5,
            "mask_confidence": 0.32,
            "mask_threshold": 0.5,
            "screen_replay_confidence": 0,
            "screen_replay_threshold": 0.5
        }
    },
    "verify_result": {
        "result_faceid": {
            "confidence": 68.918,
            "thresholds": {
                "1e-3": 64,
                "1e-4": 69,
                "1e-5": 74,
                "1e-6": 79.9
            }
        },
        "result_ref1": {
            "confidence": 68.918,
            "thresholds": {
                "1e-3": 64,
                "1e-4": 69,
                "1e-5": 74,
                "1e-6": 79.9
            }
        },
        "result_idcard_photo": {
            "confidence": 68.918,
            "thresholds": {
                "1e-3": 64,
                "1e-4": 69,
                "1e-5": 74,
                "1e-6": 79.9
            }
        },
        "result_idcard_datasource": {
            "confidence": 68.918,
            "thresholds": {
                "1e-3": 64,
                "1e-4": 69,
                "1e-5": 74,
                "1e-6": 79.9
            }
        },
        "id_exceptions": {
            "id_attacked": 0,
            "id_photo_monochrome": 0
        }
    },
    "images": {
        "image_idcard_back": "data: image/jpeg;base64,...",
        "image_idcard_front": "data: image/jpeg;base64,...",
        "image_best": "data: image/jpeg;base64,..."
    },
	"will_result": [{ 
		"will_error_message": "",
		"result": "PASS"
		}]
	"time_used": 93
}

    失败示例

    {
    "error_message": "RESULT_NOT_FOUND",
    "request_id": "1462259901,fa79992d-ca61-48de-aa50-ea337c6aad42",
    "time_used": 4
}

    # 错误码列表

    GetResult 特有的 ERROR_MESSAGE

    HTTP状态代码 错误信息 说明
    400 RESULT_NOT_FOUND 此错误类型表示传入的业务编号错误

    通用的ERROR_MESSAGE

    HTTP状态代码 错误信息 说明
    403 AUTHENTICATION_ERROR api_key和api_secret不匹配
    403 AUTHORIZATION_ERROR:<reason> api_key被停用、调用次数超限、没有调用此API的权限，或者没有以当前方式调用此API的权限。目前的<reason>有：Denied. （没有权限调用当前API）
    400 MESSAGE_ENCRYPTION_ERROR 云端对敏感信息加密失败
    403 CONCURRENCY_LIMIT_EXCEEDED 并发数超过限制
    400 MISSING_ARGUMENTS:<key> 缺少某个必选参数
    403 DATA_DESTROYED 超过可查询时间或超过最多可查询次数
    400 BAD_ARGUMENTS:<key> 某个参数解析出错（比如必须是数字，但是输入的是非数字字符串; 或者长度过长，etc.）
    404 API_NOT_FOUND 所调用的API不存在
    500 INTERNAL_ERROR 服务器内部错误，当此类错误发生时请再次请求，如果持续出现此类错误，请及时联系FaceID客服或商务
    该文档未解决您的疑问？查看常见问题
    Copyright © 2024 北京旷视科技有限公司