# 版本

5.0.0

# 描述

此接口用于生成验证请求标识，应用方通过服务器将本次活体相关的配置传到FaceID服务器，在验证无误后，返回本次业务的biz_token，用于FaceID MegLiveStill SDK的初始化。

# 调用URL

https://api.megvii.com/faceid/v5/sdk/get_biz_token

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

# 调用方法

POST 注意：用form-data格式请求

# 权限

仅当用户接入FaceID产品后，才能调用FaceID各Web API。接入FaceID的流程请咨询FaceID商务人员。

# 参数

必选/可选	参数	类型	参数说明
必选	sign	String	调用此API客户的签名，具体的签名产生方式请查阅App-鉴权说明
必选	sign_version	String	签名算法版本，请传递：hmac_sha1
必选	liveness_id	String	活体场景ID：本次活体请求相关配置在控制台可设置，并将生成的id号在接口中使用
可选	uuid	String	用于标识本次识别对应的用户唯一ID，长度不超过128字节，建议对同一用户持续使用相同ID，便于结果追溯与数据报表优化。注意：由于历史设计原因，当前在`get_biz_token`接口和`verify`接口请求参数都有uuid字段建议在`get_biz_token`接口传入uuid 若`get_biz_token`已传uuid，则`verify`接口可不传若两接口传入的uuid不一致，以`get_biz_token`接口的为准

# 返回值说明

字段	类型	说明
request_id	String	用于区分每一次请求的唯一的字符串，此字符串可以用于后续数据反查。此字段必定返回
time_used	Int	整个请求所花费的时间，单位为毫秒，此字段必定返回
biz_token	String	字符串，调用SDK时传入的信息，biz_token有效期默认1小时
error	String	当请求失败时才会返回此字符串，具体返回内容见后续错误信息章节。否则此字段不存在

# 返回值示例

正确请求返回示例

{
   "biz_token":"1531397038,f0b9eea0-6a2d-486c-a1ba-42fdf843e8cc",
   "time_used":18,
   "request_id":"1531397037,c1223c5b-c2f6-4bb7-8cbb-8993497ddbe0"
}

失败请求返回示例

{
    "error": "BAD_ARGUMENTS: sign_version"
}

# 错误码列表

HTTP状态代码	错误信息	说明
400	MISSING_ARGUMENTS: <key>	缺少某个必选参数
400	BAD_ARGUMENTS: <key>	某个参数解析出错（比如必须是数字，但是输入的是非数字字符串，或者长度过长）
403	AUTHENTICATION_ERROR	无效签名
403	AUTHORIZATION_ERROR: <reason>	api_key被停用、调用次数超限、没有调用此API的权限，或者没有以当前方式调用此API的权限 <reason>取值： API_KEY_BE_DISCONTINUED：api_key被停用 IP_NOT_ALLOWED：不允许访问的IP（预留设计） LIMIT_REACHED：这个api_key对当前API的调用量达到上限。仅当api_key为测试key DENIED：无权限调用当前API EXPIRED_SIGN：签名已过期 INVALID_SIGN：无效签名其他可能的错误码，请预留处理方案
403	CONCURRENCY_LIMIT_EXCEEDED	并发数超过限制
404	API_NOT_FOUND	所调用的API不存在
500	INTERNAL_ERROR	服务器内部错误，当此类错误发生时请再次请求，如果持续出现此类错误，请及时联系 FaceID 客服或商务