API Reference
English

活体检测API

活体检测API是用于识别检测对象是否为真人。

API 方式

Base URL

API

URL请求方式Content-Type输出格式字符集
api-base-url?partner_code=xxx&partner_key=xxxPOSTapplication/jsonJSONUTF-8
认证参数
字段类型含义建议备注
partner_codeString合作方标识必须由 TD 分配
partner_keyString合作方密钥必须由 TD 分配

请求参数

字段

类型

含义

建议

备注

image

String

人脸照片

必须

JPG、JPEG、PNG的base64编码图⽚字符流,图⽚不能超过3M

country

String

国家

必须

国家,大写,必填。两位国家码,符合 ISO 3166 标准。
调用印尼节点服务,请填入两位国家码"ID"。
调用新加坡节点服务,请填入相应的符合标准的国家码。

响应参数

字段

类型

含义

备注

code

Integer

API 状态码

message

String

状态信息

输出API具体的状态信息

sequence_id

String

响应唯一码

API用于跟踪每次请求记录的唯一标识

result

String

结果

枚举值:
成功:pass,当score >= 0.7
失败:fail,当score <0.7

score

Double

活体检测置信分

调用成功才输出。取值范围是0~1。值越大,表示真人的可能性越大。目前建议的阈值为0.7

API 状态码

CodeMessage是否计费
200Success
12223Face has not been detected
11301{parameter} empty
11304The country partner located is not open
11340{parameter} error
11350Internal error
301Service not purchased
302Service has been suspend
303Not enough balance
304Service expired
305Daily maximum volume reached

响应示例

  • 业务请求成功
{
    "code": 200,
    "message": "success",
    "sequence_id": "557a00180577433ba002201cd1b0f306",
    "result": "pass",
    "score": 0.995061
}
  • 业务请求失败
{
   "code": 11304,
   "message": "The country partner located is not open",
   "sequence_id": "d2b38289a10f48d487ee7317260078c0"
}