文档中心 > 活体检测SDK对接文档 > 活体检测-小程序API文档

1、获取认证token(服务端)

1.1、接口描述

请求地址: https://sdk.253.com/identity_auth/eid/token/getToken
请求方式: POST
请求类型: application/json

每次调用E证通服务前，需先调用本接口获取eid_token，用来串联E证通流程，在验证完成后，用于获取E证通结果信息。
默认接口请求频率限制：100次/秒。

1.2、输入参数

参数名称	必选	类型	描述
app_key	是	String	开发者平台应用管理列表中查看
app_secret	是	String	开发者平台应用管理列表中查看

1.3、输出参数

参数名称	类型	描述
eid_token	String	一次核身流程的标识，有效时间为600秒；完成核身后，可用该标识获取验证结果信息。
request_id	String	唯一请求 ID，每次请求都会返回。定位问题时需

1.4、输入示例

{
  "app_key": "m1m3Sy5gZ523887G",
  "app_secret": "7b2CFPjv2I550EVx"
}

1.5、输出示例

{
  "code": "000000",
  "message": "成功",
  "data": {
    "eid_token": "7550D3E7-9D79-4284-BEC1-9533251E18D8",
    "request_id": "f1738bc5-7895-459c-a2be-220a47314cc9"
  }
}

2、获取认证结果(服务端)

2.1、接口描述

请求地址: https://sdk.253.com/identity_auth/eid/token/check
请求方式: POST
请求类型: application/json

完成验证后，用eid_token调用本接口获取结果信息，eid_token生成后三天内（3243,600秒）可多次拉取。
默认接口请求频率限制：100次/秒。

2.2、输入参数

参数名称	必选	类型	描述
eid_token	是	String	认证流程的唯一标识，调用getToken接口时生成。
app_key	是	String	开发者平台应用管理列表中查看
app_secret	是	String	开发者平台应用管理列表中查看

2.3、输出参数

参数名称	类型	描述
Text	DetectInfoText	文本类信息。（基于对敏感信息的保护，验证使用的姓名和身份证号统一通过加密后从Eidinfo参数中返回）注意：此字段可能返回 null，表示取不到有效值。
IdCardData	DetectInfoIdCardData	身份证照片信息。注意：此字段可能返回 null，表示取不到有效值。
BestFrame	DetectInfoBestFrame	最佳帧信息。注意：此字段可能返回 null，表示取不到有效值。
EidInfo	EidInfo	Eid信息。（包括商户下用户唯一标识以及加密后的姓名、身份证号信息）注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

2.4、输入示例

{
  "app_key":"m1m3Sy5gZ523887G",
  "app_secret":"7b2CFPjv2I550EVx",
  "eid_token":"1A606BE5-053E-42B9-9768-CB4CB6D822CF"
}

2.5、输出示例

{
  "code": "000000",
  "message": "成功",
  "data": {
    "Text": {
      "ErrCode": 0,
      "ErrMsg": "成功",
      "IdCard": "440111111111111111",
      "Name": "爱新觉罗永琪",
      "OcrNation": null,
      "OcrAddress": null,
      "OcrBirth": null,
      "OcrAuthority": null,
      "OcrValidDate": null,
      "OcrName": "爱新觉罗永琪",
      "OcrIdCard": "440111111111111111",
      "OcrGender": null,
      "LiveStatus": 0,
      "LiveMsg": "成功",
      "Comparestatus": 0,
      "Comparemsg": "成功",
      "CompareLibType": "xx",
      "Sim": "76.52",
      "Location": null,
      "Mobile": null,
      "Extra": "",
      "LivenessDetail": [
        {
          "ReqTime": "1577179388135",
          "Seq": "3d12da91-db34-4e55-81c3-993a41d7ccb7",
          "Idcard": "440111111111111111",
          "Name": "爱新觉罗永琪",
          "CompareLibType": "xx",
          "Sim": "76.52",
          "IsNeedCharge": true,
          "Errcode": 0,
          "Errmsg": "成功",
          "Livestatus": 0,
          "Livemsg": "成功",
          "Comparestatus": 0,
          "Comparemsg": "成功"
        }
      ]
    },
    "IdCardData": {
      "ProcessedBackImage": "xx",
      "ProcessedFrontImage": "xx",
      "OcrFront": "xx",
      "OcrBack": "xx",
      "Avatar": "xx"
    },
    "BestFrame": {
      "BestFrame": "xx",
      "BestFrames": [
        "xx"
      ]
    },
    "EidInfo": {
      "EidCode": "xx",
      "EidSign": "xx",
      "DesKey": "xxxxxx",
      "UserInfo": "xxxxxx"
    },
    "RequestId": "f52bac9a-0aee-4fe6-8d34-7de4bce89473"
  }
}

3、数据结构

DetectInfoText

核身文本信息

名称	类型	描述
ErrCode	Integer	本次流程最终验证结果。0为成功注意：此字段可能返回 null，表示取不到有效值。
ErrMsg	String	本次流程最终验证结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。
IdCard	String	本次验证使用的身份证号。注意：此字段可能返回 null，表示取不到有效值。
Name	String	本次验证使用的姓名。注意：此字段可能返回 null，表示取不到有效值。
OcrNation	String	Ocr识别结果。民族。注意：此字段可能返回 null，表示取不到有效值。
OcrAddress	String	Ocr识别结果。家庭住址。注意：此字段可能返回 null，表示取不到有效值。
OcrBirth	String	Ocr识别结果。生日。注意：此字段可能返回 null，表示取不到有效值。
OcrAuthority	String	Ocr识别结果。签发机关。注意：此字段可能返回 null，表示取不到有效值。
OcrValidDate	String	Ocr识别结果。有效日期。注意：此字段可能返回 null，表示取不到有效值。
OcrName	String	Ocr识别结果。姓名。注意：此字段可能返回 null，表示取不到有效值。
OcrIdCard	String	Ocr识别结果。身份证号。注意：此字段可能返回 null，表示取不到有效值。
OcrGender	String	Ocr识别结果。性别。注意：此字段可能返回 null，表示取不到有效值。
LiveStatus	Integer	本次流程最终活体结果。0为成功注意：此字段可能返回 null，表示取不到有效值。
LiveMsg	String	本次流程最终活体结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。
Comparestatus	Integer	本次流程最终一比一结果。0为成功注意：此字段可能返回 null，表示取不到有效值。
Comparemsg	String	本次流程最终一比一结果描述。（仅描述用，文案更新时不会通知。）注意：此字段可能返回 null，表示取不到有效值。
Sim	String	本次流程活体一比一的分数，取值范围 [0.00, 100.00]。相似度大于等于70时才判断为同一人，也可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一）注意：此字段可能返回 null，表示取不到有效值。
Location	String	地理位置经纬度。注意：此字段可能返回 null，表示取不到有效值。
Extra	String	Auth接口带入额外信息。注意：此字段可能返回 null，表示取不到有效值。
LivenessDetail	Array	本次流程进行的活体一比一流水。注意：此字段可能返回 null，表示取不到有效值。
Mobile	String	手机号码。注意：此字段可能返回 null，表示取不到有效值。
CompareLibType	String	本次流程最终比对库源类型。包括：权威库；业务方自有库（用户上传照片、客户的混合库、混合部署库）；二次验证库；人工审核库；注意：此字段可能返回 null，表示取不到有效值。

DetectInfoIdCardData

核身身份证图片信息

名称	类型	描述
OcrFront	String	OCR正面照片的base64编码。注意：此字段可能返回 null，表示取不到有效值。
OcrBack	String	OCR反面照片的base64编码注意：此字段可能返回 null，表示取不到有效值。
ProcessedFrontImage	String	旋转裁边后的正面照片base64编码。注意：此字段可能返回 null，表示取不到有效值。
ProcessedBackImage	String	旋转裁边后的背面照片base64编码。注意：此字段可能返回 null，表示取不到有效值。
Avatar	String	身份证正面人像图base64编码。注意：此字段可能返回 null，表示取不到有效值。
WarnInfos	Array of Integer	开启身份证防翻拍告警功能后才会返回，返回数组中可能出现的告警码如下： -9102 身份证复印件告警。 -9103 身份证翻拍告警。 -9106 身份证 PS 告警。注意：此字段可能返回 null，表示取不到有效值。

DetectInfoBestFrame

核身最佳帧信息

名称	类型	描述
BestFrame	String	活体比对最佳帧Base64编码。注意：此字段可能返回 null，表示取不到有效值。
BestFrames	Array of String	自截帧Base64编码数组。注意：此字段可能返回 null，表示取不到有效值。

EidInfo

Eid出参，包括商户方用户的标识和加密的用户姓名身份证信息。

名称	类型	描述
EidCode	String	商户方 appeIDcode 的数字证书
EidSign	String	Eid中心针对商户方EidCode的电子签名
DesKey	String	商户方公钥加密的会话密钥的base64字符串
UserInfo	String	会话密钥sm2加密后的base64字符串

4、错误代码描述

返回结果中如果存在 Error 字段，则表示调用 API 接口失败。 Error 中的 Code 字段表示错误码，所有业务都可能出现的错误码为公共错误码。

错误码	描述
FailedOperation.DecryptSystemError	解密失败。
FailedOperation.StsUnAuthErrError	STS未授权。
FailedOperation.UnKnown	内部未知错误。
InternalError	内部错误。
InternalError.EncryptSystemError	加密失败。
InvalidParameter	参数错误。
InvalidParameterValue.BizTokenExpired	BizToken过期。
InvalidParameterValue.BizTokenIllegal	BizToken不合法。
UnauthorizedOperation.Arrears	帐号已欠费。
UnauthorizedOperation.NonAuthorize	账号未实名。
UnauthorizedOperation.Nonactivated	未开通服务。

开发者中心