Liveness-API

获取License API

Base URL

Singapore：https://sg-credit.apitd.net/verification/kyc/sdk/liveness/license/v1
Indonesia：http://id-credit.apitd.net/verification/kyc/sdk/liveness/license/v1

API

URL	请求方式	Content Type	输出格式	字符集
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

认证参数

字段	类型	含义	建议	备注
partner_code	String	合作方标识	必须	由TD分配
partner_key	String	合作方密钥	必须	由TD分配

请求参数

字段	类型	含义	建议	备注
session_duration	Integer	License有效时间	可选	默认时长为600秒，最大时长为86,400秒。单位为秒。

响应参数

字段	类型	含义	备注
code	Integer	API 状态码
message	String	状态信息	在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	用于跟踪每次请求记录的唯一标识
license	String	活体检测授权码	Lincese授权码用于之后的SDK活体检测过程的初始化
expiry_timestamp	Integer	授权码过期时间戳	License授权码过期时间戳，例如1715667188

响应示例

业务请求

{
   "session_duration": 600  //可选入参
}

业务请求成功

{
    "code": 200,
    "message": "success",
    "sequence_id": "17119500882*****29",
    "license": "a41701e49******3",
    "expiry_timestamp": 1715667188
}

业务请求失败

{
    "code": 11350,
    "sequence_id": "69b57131b6fb********61ccba118b60",
    "message": "Internal error"
}

获取结果 API

Base URL

Singapore：https://sg-credit.apitd.net/verification/kyc/sdk/liveness/result/v1
Indonesia：http://id-credit.apitd.net/verification/kyc/sdk/liveness/result/v1

API

URL	请求方式	Content Type	输出格式	字符集
api-base-url?partner_code=xxx&partner_key=xxx	POST	application/json	JSON	UTF-8

认证参数

字段	类型	含义	建议	备注
partner_code	String	合作方标识	必须	由 TD 分配
partner_key	String	合作方密钥	必须	由 TD 分配

请求参数

字段	类型	含义	建议	备注
liveness_id	String	活体检测查询ID	必须	SDK生成的活体检测查询ID,iOS 取 TDLivenessResultStruct 结构体中的 livenessId 作为liveness_id的值

响应参数

字段	类型	含义	备注
code	Integer	API状态码	见下方状态码列表
message	String	状态信息提示	在 API 异常状态下会输出具体的异常原因
sequence_id	String	响应唯一码	用于跟踪每次请求记录的唯一标识
image	String	活体检测人脸图片	活体检测过程中抓拍到的最佳人脸图片，base64格式
score	Double	活体检测置信分	预留字段，目前仅需要根据code字段结果判断是否通过活体检测（code=200代表真人通过） (SDK 精简版没有此字段)

响应示例

业务请求

{
  "liveness_id": 1234567
}

业务请求成功

{
  "code": "200",
  "message": "success",
  "sequence_id": "1679299854228726325924",
  "image": "\/9j\/4AAQSkZJRgABAQAAAQABAAD\/2wBDAAMCA",
  "score": 0.98958
}

业务请求失败

{
    "code": 11350,
    "sequence_id": "69b57131b6fb********61ccba118b60",
    "message": "Internal error"
}

状态码

代码	提示	是否计费
200	success 成功（真人）	是
12202	Identified as a blink attack 判断为抠眼攻击	是
12203	Identified as a mouth movement attack 判断为抠嘴攻击	是
12204	Identified as a partial face attack 判断为半张脸攻击	是
12205	Identified as a video replay attack 判断为视频回放攻击	是
12206	Identified as a black and white image 判断为黑白图片	是
12207	Identified as a paper-based attack 判断为纸面攻击	是
12208	Identified as a frame (including paper or phone frame) 判断为边框（包括纸面、手机等边框）	是
12209	Identified as a moire pattern attack 判断为摩尔纹攻击	是
12210	Identified as a face superiority attack 判断为脸优攻击	是
12211	Identified as a paper-based attack (optical flow) 判断为纸面攻击(光流)	是
12212	Identified as a mask attack 判断为面具攻击	是
12213	Identified as an ID card attack 判断为证卡攻击	是
12214	Identified as a 3D mask attack 判断为3D面具攻击	是
12215	Identified as a synthetic image attack 判断为合成图像攻击	是
12216	Identified as a black-market software attack 判断为黑产软件攻击	是
12217	Identified as a T-type mask attack 判断为T型面具攻击	是
12218	Identified as a blurry image 判断为模糊图片	是
12219	Suspected deepfake image attack 疑似深伪图像攻击	是
12220	Suspected high-resolution screen attack 疑似高清屏幕攻击	是
12221	Light verification failed 光线校验失败	是
12222	Injection attack 注入攻击	是
12250	Verification error 其他活体攻击	是
11350	Internal error 内部错误	否