接入文档
FaceID基础版
H5接入
API调用
获取Token
获取Token

# 1、接口地址

POST https://api.megvii.com/faceid/lite/get_token

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

说明：此接口提供FaceID H5验证服务，通过此接口客户可以获得一个token（token唯一且只能使用一次）。接口同时还能帮助完成人脸比对，并在完成验证后自动将人脸比对结果返回，方便集成开发。

# 2、入参说明

# 2.1、基础参数

必选／可选 参数 类型 参数说明
必选 api_key String 调用此API的api_key
必选 api_secret String 调用此API的api_key的secret
必选 return_url String 用户完成或取消验证后网页跳转的目标URL（回调方法为Post）
必选 notify_url String 用户完成验证、取消验证、或验证超时后，由FaceID服务器请求客户服务器的URL（推荐为HTTPS页面，如果为HTTP则用户需要通过签名自行校验数据可信性，回调方法为Post） 注：出于安全性考虑，FaceID验证服务服务对服务器端回调端口有白名单要求，支持的端口有：443，5000，16003，8883，8028
必选 biz_no String 客户业务流水号，该号必须唯一。并会在notify和return时原封不动的返回给您的服务器，以帮助您确认每一笔业务的归属。此字段不超过128字节
可选 scene_id String 在控制台配置的对应使用场景的scene_id，用以自定义验证流程中的视觉元素 如果不传此参数，则选择在控制台中设置的默认scene 如果控制台中没有设定任何scene，则采用系统默认方案 如果传入了不存在的scene_id，调用将失败且返回错误码400（BAD_ARGUMENTS）
可选 procedure_type String 刷脸活体验证流程的选择。目前仅取以下值：
  • "video"：通过自拍有声视频方式进行活体验证，支持用户拍摄的一段0.5s-20s的视频
  • "selfie"：通过两张自拍方式进行活体验证
  • "still"：通过自拍一段人脸视频进行活体认证。该值只有在控制台中选择使用“lite2.0”时才生效，若未应用lite2.0而传入"still"，则返回错误码400（BAD_ARGUMENTS）。支持用户拍摄一段0.5s-10s的视频。
  • “flash”：通过炫彩活体方式进行活体验证。该值只有在控制台中选择使用“lite2.0”时才生效，若未应用lite2.0而传入"flash"，则返回错误码400（BAD_ARGUMENTS）
  • “meglive_flash”：通过灵动活体方式进行活体验证。该值只有在控制台中选择使用“lite2.0”时才生效，若未应用lite2.0而传入"meglive_flash"，则返回错误码400（BAD_ARGUMENTS）
  • “distance”：通过距离活体方式进行活体验证。该值只有在控制台中选择使用“lite2.0”时才生效，若未应用lite2.0而传入"distance"，则返回错误码400（BAD_ARGUMENTS）
本参数默认值为“video”
可选 procedure_priority String 本参数可选，通过本参数配置不支持webrtc技术的降级方式，包括炫彩活体(procedure_type为flash)，静默活体webrtc模式(procedure_type为still，update_rtc为1)
  • video：降级为自拍有声视频方式
  • still：优先尝试still录制，如果不支持，降级到系统相机录制静默视频
  • keep：不进行降级，若遇到浏览器无法支持的情况，直接返回
默认值：
  • 当procedure_type为flash时，默认值是‘video’
  • 当procedure_type为still时，默认值是‘still’
  • 当procedure_type为meglive_flash时，默认值是‘video’
  • 当procedure_type为distance时，默认值是‘video’
设置其他值，均会返回错误码400（BAD_ARGUMENTS）
必选 comparison_type String 设定本次服务的类型，目前支持的比对类型为“人脸核身”（取值“1”）、“人脸比对”（取值“0”）和“只活体不比对”（取值“-1”）。传递其他值调用将识别，返回错误码400（BAD_ARGUMENTS）
  • “1”表示人脸核身，表示最终的用户自拍照片将于参考照片比对
  • “0”表示人脸比对，FaceID将使用用户自己提供的照片（参数image_ref[x]）作为比对人脸照
  • “-1”表示只进行活体不进行比对
请注意：
  1. 本参数影响验证流程中是否存在身份证拍摄环节：如果为“1”，则可选择包含身份证拍摄；如果为“0”，验证流程中将没有身份证拍摄
  2. 本参数取什么值将决定下面参数组使用哪一组参数
人脸核身时（comparison_type ＝ 1） 必选 idcard_mode String 传递参数“0”，“1”，“2”，“3”或“4”，表示获取用户身份证信息的方法。传递其他值调用将识别，返回错误码400（BAD_ARGUMENTS）
  • 0：不拍摄身份证，而是通过 idcard_name / idcard_number 参数传入
  • 1：仅拍摄身份证人像面，可获取人像面所有信息
  • 2：拍摄身份证人像面和身份证国徽面，可获取身份证所有信息
  • 3：不拍摄身份证，但会要求用户在界面上输入身份证号和姓名
  • 4：拍摄身份证人像面或用户输入身份证号和姓名，用户可在界面上自行选择身份证录入方法。注意：该参数只有在控制台中选择使用“lite2.0”时才生效，若未应用lite2.0而传入4，则返回错误码400（BAD_ARGUMENTS）
可选 idcard_uneditable_field String 选择用户不可编辑的字段。当选择拍摄身份证来获取上面的文字信息时，会由于OCR算法的问题导致文字识别不准确（如：生僻字、形近字），通过该参数可以限制用户对识别得到的结果进行编辑。（如：身份证号的识别都是准确的，可以限制用户不能编辑此字段） 目前可以选为不可修改的字段有 姓名（idcard_name），身份证号（idcard_number），身份证有效期（idcard_valid_date），签发机关（idcard_issued_by）。传递参数时用逗号隔开，可以同时设置多个参数。例子：idcard_uneditable_field = idcard_number，idcard_valid_date 表示身份证号和过期时间都不可编辑，如果尝试编辑则会提示需要重新拍摄。传入其他值或格式不对，本次调用将失败，返回错误码400（BAD_ARGUMENTS） 本参数默认值为空，表示所有字段都可以编辑 请注意，如果您设置了scene_id参数、或者在控制台里设置了默认的场景，它对应的场景配置里将覆盖您此处的设定
条件必选 idcard_name String idcard_name，需要人脸核身对象的姓名，使用UTF-8编码 idcard_number， 需要人脸核身对象的身份证号，也就是一个18位长度的字符串 idcard_mode = 0时，这两个参数必须传；在其他情况下可以不传，即使传递了也不会使用
条件必选 idcard_number String
可选 image_ref[x] File 多张由您自己提供的参照人脸照片。x表示此参数可重复多次，其中1 <= x <= 2，即表示可以传最多二张参照人脸照片（参数分别为image_ref1, image_ref2） 如果在image_ref1、image_ref2中的任一张图片里没有找到人脸，将返回错误码400（NO_FACE_FOUND) 如果这些图片中任一张中有多张脸，将返回错误码400（MULTIPLE_FACES）
人脸比对时（comparison_type ＝ 0） 必选 uuid String 如果用户不使用参考数据进行比对，则上传此字段，用于标志本次识别对应的用户的唯一ID，要求不长于512字节。建议您对来自同一用户的比对请求使用同样的ID，这非常有利于您反查验证结果以及获得更好的数据报表体验
必选 image_ref[x] File 多张由您自己提供的参照人脸照片。x表示此参数可重复多次，其中1 <= x <= 2，即表示可以传最多二张参照人脸照片（参数分别为image_ref1, image_ref2） 如果在image_ref1、image_ref2中的任一张图片里没有找到人脸，将返回错误码400（NO_FACE_FOUND) 如果这些图片中任一张中有多张脸，将返回错误码400（MULTIPLE_FACES）
只进行活体不进行比对时（comparison_type ＝ -1） 必选 uuid String 用于标志本次识别对应的用户的唯一ID，要求不长于512字节。建议您对来自同一用户的比对请求使用同样的ID，这非常有利于您反查验证结果以及获得更好的数据报表体验

# 2.2、高级参数

可选 参数 类型 参数说明
可选 encryption_type String 是否开启传输数据加密，详细说明见：加密说明
  • 0：不开启（默认）
  • 1：SM2
  • 2：RSA
可选 biz_extra_data String 在调用notify_url和return_url时会返回的额外数据，用户可以用此接口来传递一些额外信息，以帮助您调试和信息传递。此字段不超过4096字节
可选 web_title String 验证网页展示用的标题文字。此字段不超过32字节，但考虑到显示效果，建议控制在10个中文字符以内 此参数默认为空，此时系统将采用默认的标题 请注意，如果您设置了scene_id参数、或者在控制台里设置了默认的场景，它对应的场景配置将覆盖您此处的设定
可选 update_rtc String 此参数用来设置静默活体数据的传输方式 0：使用先录制视频，后上传的方式 1：使用webrtc技术，实时传输，如果用户手机不支持webrtc技术，按照procedure_priority的配置进行降级 默认值：0
可选 liveness_action_count int 本参数用来指定灵动活体动作个数，可选1-3个动作，默认为1个动作
可选 liveness_action_sequence String 本参数用来指定灵动活体动作序列，眨眼（1）、张嘴（2）、摇头（3）、点头（4），例如：1324
  • 参数为空则按照动作个数随机生成动作序列
  • 如果动作序列个数与动作个数不匹配，返回错误码400（BAD_ARGUMENTS）
可选 liveness_action_timeout int 本参数用来指定灵动活体单个动作阶段超时时间，单位秒，默认为10s，最多60s
可选  liveness_preferences  String 本参数可选，通过一系列配置项来调节活体检测的严格度。目前可用的选项有：
  • speed：极速模式，追求更快速的操作体验，通过率更高
  • normal：标准模式，更加均衡的方案，通过率和攻击检出率都比较均衡
  • strict：严格模式，追求更高的攻击检出率，保证安全
默认值：normal
  • 视频活体：speed(待支持，敬请期待)；normal(支持，等于老版本的：none); strict(支持，等于老版本的：video_strict)
  • 静默活体：speed(待支持，敬请期待)；normal(支持，等于老版本的：none); strict(支持，等于老版本的：still_strict)
  • 炫彩活体：speed(支持)；normal(支持，等于老版本的：none); strict(支持)
  • 灵动活体：speed(支持)；normal(支持); strict(支持)
  • 距离活体：speed(待支持，敬请期待)；normal(支持); strict(待支持，敬请期待)
  • 双角度活体：speed(支持，等于老版本的：selfie_no_metadata_check)；normal(支持，等于老版本的：none); strict(待支持，敬请期待)
注意：支持老版本中客户传入的参数：none、selfie_no_metadata_check、video_strict、still_strict，设置其他值，均会返回400（BAD_ARGUMENTS）
可选 get_shooting_error String 是否获取拍摄错误，本参数取值如下：
  • “1”： 获取长时间未上传录制视频错误
  • “0”：不获取长时间未上传视频错误
注：当本参数取值为“1”，且FaceID人脸验证过程中无法获取到用户拍摄的视频时，我们将会给return_url和notify_url中返回相应的错误信息：{"shooting_error":true/false}        当本参数取值为“0”时，即使FaceID人脸验证过程中无法获取到用户拍摄的视频，也不返回相应的错误信息        本参数默认取值为“0”
 可选 maximum_shooting_time  int 用户点击开始拍摄后的超时时间设置，超过本时间后，用户界面将弹窗提示“长时间未收到录制视频”
注：本参数可选设置范围为2s-60s
       本参数默认设置为15s，建议设置时间为10-15s
可选 multi_oriented_detection String 决定对于image_ref[x]参数对应的图片，当检测不出人脸时，是否旋转90度、180度、270度后再检测人脸。本参数取值只能是 “1” 或 "0" （缺省值为“0”）:
  • 1：要旋转检测
  • 0：不旋转
  • 其他值：返回错误码400（BAD_ARGUMENTS）
请注意：设置此参数为1可能会轻微增加误检人脸的概率，如果您明确您的业务场景里不存在非正向的人脸图片、或概率极低，建议勿设置此参数
可选 fail_when_ref_multiple_faces String 用于设置参照人脸图（image_ref[x]）检测到多张人脸时，是否立刻返回错误，本参数取值如下：
  • 1：立即返回错误码400（MULTIPLE_FACES:）
  • 0：取最大脸继续对比
注：本参数默认值为“1”。
可选 return_multifaces_tag String 是否返回活体采集过程中的多人脸标识
  • 0：不返回（默认值）
  • 1：返回
可选 fmp_mode String 决定在活体检测结果中，是否进行云端假脸攻击判断，默认值为1
  •  1：在活体检测结果中，不进行云端假脸攻击判断（合成脸、面具攻击、屏幕翻拍），但返回假脸攻击具体分数。您可以根据自身业务需要，结合云端假脸攻击具体分数设计后续流程
  •  0：在活体检测结果中，判断云端假脸攻击情况
当您选择RTC方式的活体方式时（update_rtc），该字段不生效，即RTC类活体方式会始终进行云端假脸攻击判断
注：活体检测结果，请参见“Lite-GetResult”返回值的“liveness_result”段落
可选 get_fail_reason String 决定在WEBRTC_UNSUPPORTED时，是否返回失败原因（缺省值为“0”）
  • 1：获取失败原因
  • 0：不获取失败原因
可选 get_still_type Int 决定是否返回静默活体验证方式，仅当get_result返回的procedure_type为still时生效，默认不返回
  • 0：不返回
  • 1：返回
可选 face_occlusion_detection String 用于设置是否开启人脸遮挡检测
  • 0（默认）：不开启；
  • 1：开启，如发生全程人脸遮挡，则活体不通过
可选 eye_close_detection String 用于设置是否开启闭眼检测
  • 0：不开启；
  • 1：开启
默认值：
  • 当procedure_type为flash时，默认值是‘1’
  • 当procedure_type为meglive_flash时，默认值是‘1’
  • 当procedure_type为distance时，默认值是‘1’
  • 当procedure_type为still时，默认值是‘1’
  • 当procedure_type为video时，默认值是‘0’
可选 action_http_method String 回跳到return_url的方式
  • POST（默认）：以form格式返回更为详细的数据，详见 回调说明；
  • GET：以return_url地址拼接参数的格式返回biz_id，详见 回调说明；
可选 redirect_type String 页面跳转模式（当redirect_type =1且action_http_method=GET时，支持点击浏览器或者操作系统的返回键可返回到进入lite之前的页面）
  • 0（默认）：不传或0，则正常跳转；
  • 1：页面使用 replace 方式跳转，不在浏览器 history 中留下记录；

# 3、返回结果

字段 类型 说明
request_id String 用于区分每一次请求的唯一的字符串，此字符串可以用于后续数据反查，此字段必定返回
time_used Int 整个请求所花费的时间，单位为毫秒，此字段必定返回
token String 一个字符串，可用于DoVerification接口，调用DoVerification时传入此参数，即可按照上述配置进行活体检测（注：每个token只能被使用一次）
biz_id String 业务流串号，可以用于反查比对结果
expired_time Int 一个时间戳，表示token的有效期
error_message String 当请求失败时才会返回此字符串，具体返回内容见后续错误信息章节，否则此字段不存在

成功示例

{
    "time_used": 5,
    "token": "34fb21937e47ae719f11cbc719615687",
    "biz_id": "1462259748,52b13fb5-8dfb-4537-a62b-a641d5e929f1",
    "request_id": "1462257147,3149525e-2c24-4862-8e9f-92040595f0a4",
    "expired_time": 1462257765
}

失败示例

{
    "error_message": "BAD_ARGUMENTS: return_url",
    "request_id": "1461740007,71eeb124-08f0-47b3-8fc8-ac048cfa1372",
    "time_used": 4
}

# 4、错误码列表

GetToken 特有的 ERROR_MESSAGE

HTTP状态代码 错误字段名称 值 说明
400 error_message IMAGE_ERROR_UNSUPPORTED_FORMAT:<param> 参数<param>对应的图像无法正确解析，有可能不是一个图像文件、或有数据破损。<param>为 image_ref1、 image_ref2中的一个。请注意：<param>只会有一项，即第一个满足条件的名称
400 error_message NO_FACE_FOUND 表示上传的 image_ref[x] 的图像中，没有检测到人脸
400 error_message MULTIPLE_FACES 表示上传的 image_ref[x] 的图像中，检测到了多张人脸
400 error_message INVALID_NAME_FORMAT 人脸核身时，idcard_name参数字符数过多（多于32字符）、或者使用错误的编码（姓名要求以UTF-8编码）
400 error_message INVALID_IDCARD_NUMBER 人脸核身时，idcard_number参数不是正确的身份证号码格式。身份证号码必定为18位数字，且最后一位可以是X（大小写均可）
400 error_message KEY_NOT_FOUND encryption_type开启加密，但未配置加密公钥和解密私钥

通用的ERROR_MESSAGE

HTTP状态代码 错误字段名称 值 说明
403 error AUTHENTICATION_ERROR api_key 和 api_secret不匹配
403 error AUTHORIZATION_ERROR:<reason> api_key被停用、调用次数超限、没有调用此API的权限，或者没有以当前方式调用此API的权限。目前的<reason>有："Denied." :（没有权限调用当前API）"No data source permission." : （表示没有调用第三方联网核查）
403 error_message CONCURRENCY_LIMIT_EXCEEDED 并发数超过限制
400 error_message MISSING_ARGUMENTS:<key> 缺少某个必选参数
400 error_message BAD_ARGUMENTS:<key> 某个参数解析出错（比如必须是数字，但是输入的是非数字字符串; 或者长度过长）
404 error API_NOT_FOUND 所调用的API不存在
500 error_message INTERNAL_ERROR 服务器内部错误，当此类错误发生时请再次请求，如果持续出现此类错误，请及时联系 FaceID 客服或商务
该文档未解决您的疑问？查看常见问题
Copyright © 2024 北京旷视科技有限公司