{ "name": "faceid", "display_name": "人脸核身", "description": "腾讯云慧眼人脸核身是一组对用户身份信息真实性进行验证审核的服务套件，提供人脸核身、身份信息核验、银行卡要素核验和运营商类要素核验等各类实名信息认证能力。本章节API 主要介绍 api 的调用方式、如何通过API调用人脸核身SaaS和pass服务相关接口，以及如何调用实名信息认证相关产品。", "domain": "ai", "api_version": "2018-03-01", "endpoint": "faceid.tencentcloudapi.com", "actions": [ { "name": "BankCard2EVerification", "description": "本接口用于校验姓名和银行卡号的真实性和一致性。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "BankCard", "type": "string", "required": true, "description": "银行卡。", "example": "6225768888888888" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、银行卡号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "Name", "BankCard" ] }, { "name": "BankCard4EVerification", "description": "本接口用于输入银行卡号、姓名、开户证件号、开户手机号，校验信息的真实性和一致性。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "BankCard", "type": "string", "required": true, "description": "银行卡。", "example": "6225768888888888" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号码。", "example": "16137688175" }, { "name": "IdCard", "type": "string", "required": true, "description": "开户证件号。 - 与CertType参数的证件类型一致，如：身份证，则传入身份证号。", "example": "11204416541220243X" }, { "name": "CertType", "type": "integer", "required": false, "description": "证件类型。 - 请确认该证件为开户时使用的证件类型，未用于开户的证件信息不支持验证。 - 目前默认为0：身份证，其他证件类型暂不支持。", "example": "0" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号、手机号、银行卡号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "Name", "BankCard", "Phone", "IdCard" ] }, { "name": "BankCardVerification", "description": "本接口用于银行卡号、姓名、开户证件号信息的真实性和一致性。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "开户证件号。 - 与CertType参数的证件类型一致，如：身份证，则传入身份证号。", "example": "440111201903211111" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "BankCard", "type": "string", "required": true, "description": "银行卡。", "example": "6225768888888888" }, { "name": "CertType", "type": "integer", "required": false, "description": "证件类型。 - 请确认该证件为开户时使用的证件类型，未用于开户的证件信息不支持验证。 - 目前默认：0 身份证，其他证件类型暂不支持。", "example": "0" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号、银行卡号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "IdCard", "Name", "BankCard" ] }, { "name": "CheckBankCardInformation", "description": "银行卡基础信息查询", "status": "online", "parameters": [ { "name": "BankCard", "type": "string", "required": true, "description": "银行卡号。", "example": "6225768888888888" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（银行卡号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "BankCard" ] }, { "name": "CheckEidTokenStatus", "description": "用于轮询E证通H5场景EidToken验证状态。", "status": "online", "parameters": [ { "name": "EidToken", "type": "string", "required": true, "description": "E证通流程的唯一标识，调用[GetEidToken](https://cloud.tencent.com/document/product/1007/54089)接口时生成。", "example": "2B3B265E-2C91-5A62-B32D-D0CA5C3F1A15" } ], "required": [ "EidToken" ] }, { "name": "CheckIdCardInformation", "description": "传入身份证人像面照片，识别身份证照片上的信息，并将姓名、身份证号、身份证人像照片与权威库的证件照进行比对，是否属于同一个人，从而验证身份证信息的真实性。", "status": "online", "parameters": [ { "name": "ImageBase64", "type": "string", "required": false, "description": "身份证人像面的 Base64 值。支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经Base64编码后不超过 7M。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。ImageBase64、ImageUrl二者必须提供其中之一。若都提供了，则按照ImageUrl\u0026gt;ImageBase64的优先级使用参数。", "example": "/9j/4AAQSkZJRg.....s97n//2Q==" }, { "name": "ImageUrl", "type": "string", "required": false, "description": "身份证人像面的 Url 地址支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。支持的图片大小：所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。", "example": "http://www.qq.com/image.jpg" }, { "name": "Config", "type": "string", "required": false, "description": "配置。以下可选字段均为bool 类型，默认false。CopyWarn，复印件告警。BorderCheckWarn，边框和框内遮挡告警。ReshootWarn，翻拍告警。DetectPsWarn，PS检测告警（疑似存在PS痕迹）。TempIdWarn，临时身份证告警。Quality，图片质量告警（评价图片模糊程度）。SDK 设置方式参考：Config = Json.stringify({\u0026quot;CopyWarn\u0026quot;:true,\u0026quot;ReshootWarn\u0026quot;:true})。API 3.0 Explorer 设置方式参考：Config = {\u0026quot;CopyWarn\u0026quot;...", "example": "{\"CopyWarn\":true,\"ReshootWarn\":true}" }, { "name": "IsEncrypt", "type": "boolean", "required": false, "description": "是否需要对返回中的敏感信息进行加密。默认false。敏感信息包括：Response.IdNum、Response.Name。", "example": "false" }, { "name": "IsEncryptResponse", "type": "boolean", "required": false, "description": "是否需要对响应体加密。", "example": "false" }, { "name": "Encryption", "type": "object", "required": false, "description": "是否需要对返回中的敏感信息进行加密,需指定加密算法Algorithm、CBC加密的初始向量、加密后的对称密钥。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "CheckIdNameDate", "description": "本接口用于校验姓名、身份证号、身份证有效期的真实性和一致性。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "ValidityBegin", "type": "string", "required": true, "description": "身份证有效期开始时间。 - 格式：YYYYMMDD，如：20210701。", "example": "20160607" }, { "name": "ValidityEnd", "type": "string", "required": true, "description": "身份证有效期到期时间。格式：YYYYMMDD，长期用“00000000”代替，如：20210701。", "example": "20250607" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "Name", "IdCard", "ValidityBegin", "ValidityEnd" ] }, { "name": "CheckPhoneAndName", "description": "手机号二要素核验接口用于校验手机号和姓名的真实性和一致性，支持的手机号段详情请查阅运营商类文档。", "status": "online", "parameters": [ { "name": "Mobile", "type": "string", "required": true, "description": "⼿机号。", "example": "16137688175" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "Mobile", "Name" ] }, { "name": "DetectAIFakeFaces", "description": "基于多模态的AI大模型算法，提供对人脸图片、视频的防攻击检测能力，可针对性有效识别高仿真的AIGC换脸、高清翻拍、批量黑产攻击、水印等攻击痕迹，增强对图片和视频的防伪安全能力。", "status": "online", "parameters": [ { "name": "FaceInput", "type": "string", "required": false, "description": "传入需要检测的人脸图片或人脸视频（当前仅支持单人脸检测），使用base64编码的形式，如您的场景视频和图片都有，我们更建议您使用视频进行检测，为了提供更好的检测效果，请您注意以下输入数据的限制与建议： - 图片的Base64值：建议整体图像480x640的分辨率，脸部大小在 100X100 以上，由手机前置摄像头拍摄。 Base64编码后的图片数据大小建议不超过3M、最大不可超过10M，...", "example": "/9j/4AAQSkZJRg.....s97n//2Q==" }, { "name": "FaceInputType", "type": "integer", "required": false, "description": "传入的类型。 - 取值范围： 1：传入的是图片类型。 2：传入的是视频类型。其他：返回错误码InvalidParameter。若您未使用Encryption进行加密传输，则本字段为必填参数。", "example": "1" }, { "name": "Encryption", "type": "object", "required": false, "description": "是否需要对请求信息进行全包体加密。 - 支持的加密算法:AES-256-CBC、SM4-GCM。 - 有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] }, { "name": "EncryptedBody", "type": "string", "required": false, "description": "加密后的密文。 - 加密前的数据格式如下:{\"FaceInput\":\"AAAAA\",\"FaceInputType\":1}。", "example": "fH6Fc1xHm......UrjSoYE" } ], "required": [] }, { "name": "DetectAuth", "description": "每次调用人脸核身SaaS化服务前，需先调用本接口获取BizToken，用来串联核身流程，在验证完成后，用于获取验证结果信息。", "status": "online", "parameters": [ { "name": "RuleId", "type": "string", "required": true, "description": "业务流程ID。 - 用于细分客户使用场景, 可为业务配置不同的业务流程。 - 申请开通服务后，登录腾讯云[慧眼人脸核身控制](https://console.cloud.tencent.com/faceid)进行创建，审核通过后即可调用。 - 如有疑问，请添加[腾讯云人脸核身小助手](https://cloud.tencent.com/document/product/1007/56130)进行咨询。", "example": "1" }, { "name": "TerminalType", "type": "string", "required": false, "description": "本接口不需要传递此参数。", "example": "本接口不需要传递此参数。" }, { "name": "IdCard", "type": "string", "required": false, "description": "验证人的身份证号码。 - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": false, "description": "验证人的姓名。 - 是否必传基于[控制台](https://console.cloud.tencent.com/faceid/access)申请业务流程时配置的提示。 - 最长长度32位。中文请使用UTF-8编码。", "example": "韦小宝" }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "认证结束后重定向的回调链接地址，仅微信H5场景使用。 - 最长长度1024位。 - 默认值：[腾讯云人脸核身产品介绍页](URL Here)https://cloud.tencent.com/product/faceid?Is=sdk-topnav", "example": "https://www.qq.com" }, { "name": "Extra", "type": "string", "required": false, "description": "透传字段，在获取验证结果时返回。 - 最长长度1024位。", "example": "Orderid=f904f4cf75db4f8fdc4f942c7f7a" }, { "name": "ImageBase64", "type": "string", "required": false, "description": "用于人脸比对的图像数据，使用base64编码。 - Base64编码后的图片数据大小不超过3M。 - 仅支持jpg、png格式。 - 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。", "example": "/9j/4AAQSkZJRg.....s97n//2Q==" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] }, { "name": "IntentionVerifyText", "type": "string", "required": false, "description": "意愿核身（朗读模式）使用的文案。 - 若未使用意愿核身（朗读模式），则该字段无需传入。 - 最长可接受120的字符串长度。", "example": "我同意办理该业务。" }, { "name": "IntentionQuestions", "type": "array", "required": false, "description": "意愿核身（语音播报+语音回答模式）使用的文案。 - 包括：系统语音播报的文本、需要核验的标准文本。 - 问答模式支持1-10轮（不超过10轮）的意愿确认。", "example": "无", "item_type": "object", "children": [ { "name": "Question", "type": "string", "required": true, "description": "当选择语音问答模式时，系统自动播报的问题文本。 - 最大长度为250个字符。", "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。" }, { "name": "Answers", "type": "array", "required": true, "description": "当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表。 - 传入后可自动判断用户回答文本是否在标准文本列表中。 - 列表长度最大为50，单个答案长度限制10个字符。", "example": "[\"同意\", \"我同意\", \"确认\", \"我确认\"]", "item_type": "string" } ] }, { "name": "IntentionActions", "type": "array", "required": false, "description": "意愿核身（点头确认模式）使用的文案。 - 若未使用意愿核身（点头确认模式），则该字段无需传入。 - 点头确认模式支持1-10轮（不超过10轮）的意愿确认。", "example": "无", "item_type": "object", "children": [ { "name": "Text", "type": "string", "required": true, "description": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为250个字符。", "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。" } ] }, { "name": "Config", "type": "object", "required": false, "description": "意愿核身流程配置。", "example": "无", "children": [ { "name": "IntentionRecognition", "type": "boolean", "required": false, "description": "意愿核身过程中识别用户的回答意图，开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过，默认开启。", "example": "true" }, { "name": "IntentionType", "type": "integer", "required": false, "description": "意愿核身类型，默认为0： 0：问答模式，DetectAuth接口需要传入IntentionQuestions字段； 1：点头模式，DetectAuth接口需要传入IntentionActions字段；", "example": "0" }, { "name": "MouthOpenRecognition", "type": "boolean", "required": false, "description": "用户语音回答过程中是否开启张嘴识别检测，默认不开启，仅在意愿核身问答模式中使用。", "example": "false" }, { "name": "Speed", "type": "integer", "required": false, "description": "意愿核身语音播报速度，配置后问答模式和点头模式的语音播报环节都会生效，默认值为0： 0：智能语速（根据播报文案的长度自动调整语音播报速度） 1：固定1倍速 2：固定1.2倍速 3：固定1.5倍速", "example": "0" } ] } ], "required": [ "RuleId" ] }, { "name": "EncryptedPhoneVerification", "description": "本接口用于校验手机号、姓名和身份证号的真实性和一致性，入参支持明文、MD5和SHA256加密传输。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号，加密方式以EncryptionMode为准", "example": "21b2ad431ee1f6d32c3f54c23c687751" }, { "name": "Name", "type": "string", "required": true, "description": "姓名，加密方式以EncryptionMode为准", "example": "615db57aa314529aaa0fbe95b3e95bd3" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号，加密方式以EncryptionMode为准", "example": "18c6f9a0ca21c6bc9c58675adfc4196e" }, { "name": "EncryptionMode", "type": "string", "required": true, "description": "敏感信息的加密方式，目前支持明文、MD5和SHA256加密传输，参数取值： 0：明文，不加密 1：使用MD5加密 2：使用SHA256 3：使用SM3加密", "example": "1" } ], "required": [ "IdCard", "Name", "Phone", "EncryptionMode" ] }, { "name": "GetActionSequence", "description": "使用动作活体检测模式前，需调用本接口获取动作顺序。", "status": "online", "parameters": [ { "name": "ActionType", "type": "string", "required": false, "description": "默认不需要使用。", "example": "0" } ], "required": [] }, { "name": "GetDetectInfo", "description": "完成验证后，用BizToken调用本接口获取结果信息，BizToken生成后三天内（3\\*24\\*3,600秒）可多次拉取。", "status": "online", "parameters": [ { "name": "BizToken", "type": "string", "required": true, "description": "人脸核身流程的标识，调用DetectAuth接口时生成。", "example": "CE661F1A-0F1E-45BD-BE13-34C05CEA7681" }, { "name": "RuleId", "type": "string", "required": true, "description": "用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请加慧眼小助手微信（faceid001）进行咨询。", "example": "0" }, { "name": "InfoType", "type": "string", "required": false, "description": "指定拉取的结果信息，取值（0：全部；1：文本类；2：身份证正反面；3：视频最佳截图照片；4：视频）。如 134表示拉取文本类、视频最佳截图照片、视频。默认值：0", "example": "0" } ], "required": [ "BizToken", "RuleId" ] }, { "name": "GetDetectInfoEnhanced", "description": "完成验证后，用BizToken调用本接口获取结果信息，BizToken生成后三天内（3\\*24\\*3,600秒）可多次拉取。", "status": "online", "parameters": [ { "name": "BizToken", "type": "string", "required": true, "description": "人脸核身流程的标识，调用[DetectAuth](https://cloud.tencent.com/document/product/1007/31816)接口时生成。", "example": "CF742D11-BD49-4704-A33F-B9372D6322D6" }, { "name": "RuleId", "type": "string", "required": true, "description": "用于细分客户使用场景，由腾讯侧在线下对接时分配。", "example": "5" }, { "name": "InfoType", "type": "string", "required": false, "description": "指定拉取的结果信息。 - 取值（0：全部；1：文本类；2：身份证信息；3：视频最佳截图信息；4：视频信息；5：意愿核身朗读模式相关结果；6：意愿核身问答/点头模式相关结果）。 - 例如 13 表示拉取文本类、视频最佳截图信息。 - 默认值：0", "example": "13" }, { "name": "BestFramesCount", "type": "integer", "required": false, "description": "从活体视频中截取一定张数的自截帧。 - 默认值为0，最大值为10，超出10的最多只给10张。 - InfoType需要包含3。", "example": "1" }, { "name": "IsCutIdCardImage", "type": "boolean", "required": false, "description": "是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。", "example": "false" }, { "name": "IsNeedIdCardAvatar", "type": "boolean", "required": false, "description": "是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。", "example": "false" }, { "name": "IsEncrypt", "type": "boolean", "required": false, "description": "已弃用。", "example": "false" }, { "name": "Encryption", "type": "object", "required": false, "description": "是否需要对返回中的敏感信息进行加密。 - 只需指定加密算法Algorithm即可，其余字段传入默认值。 - 敏感信息包括：Response.Text.IdCard、Response.Text.Name、Response.Text.OcrIdCard、Response.Text.OcrName。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] }, { "name": "IsEncryptResponse", "type": "boolean", "required": false, "description": "是否对回包整体进行加密。", "example": "false" }, { "name": "IsReturnAllVideo", "type": "boolean", "required": false, "description": "是否需要返回认证中间过程的刷脸重试视频，默认不开启，多段视频需要存储到COS空间中，因此开启后还需要额外开启数据存储服务才可生效。详见[数据存储指引](https://cloud.tencent.com/document/product/1007/104229)。", "example": "false" } ], "required": [ "BizToken", "RuleId" ] }, { "name": "GetEidResult", "description": "完成验证后，用EidToken调用本接口获取结果信息，EidToken生成后三天内（3\\*24\\*3,600秒）可多次拉取。", "status": "online", "parameters": [ { "name": "EidToken", "type": "string", "required": true, "description": "E证通流程的唯一标识，调用[GetEidToken](https://cloud.tencent.com/document/product/1007/54089)接口时生成。", "example": "CE661F1A-0F1E-45BD-BE133-34C05CEA76812" }, { "name": "InfoType", "type": "string", "required": false, "description": "指定需要拉取的结果信息。 - 取值范围： 0：全部。 1：文本类。 2：身份证信息。 3：最佳截图信息。 5：意愿核身朗读模式相关结果。 6：意愿核身问答/点头模式相关结果。 - 例如 13表示拉取文本类、最佳截图信息。 - 默认值：0", "example": "1" }, { "name": "BestFramesCount", "type": "integer", "required": false, "description": "从活体视频中截取一定张数的最佳帧。 - 默认为0，最大为3，超出3的最多只给3张。 - InfoType需要包含3。", "example": "1" }, { "name": "IsCutIdCardImage", "type": "boolean", "required": false, "description": "是否对身份证照片进行裁边。 - 默认为false。 - InfoType需要包含2。", "example": "false" }, { "name": "IsNeedIdCardAvatar", "type": "boolean", "required": false, "description": "是否需要从身份证中抠出头像。 - 默认为false。 - InfoType需要包含2。", "example": "false" } ], "required": [ "EidToken" ] }, { "name": "GetEidToken", "description": "每次调用E证通服务前，需先调用本接口获取EidToken，用来串联E证通流程，在验证完成后，用于获取E证通结果信息。", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "EID商户ID。 - 商户ID通过人脸核身控制台[自助接入](https://console.cloud.tencent.com/faceid/access)申请。 - 商户ID与您通过腾讯云人脸核身控制台完成自助接入时所使用的腾讯云账号绑定。 - 必须使用申请该商户ID时登录的腾讯云账号所对应的腾讯云API密钥调用该接口。", "example": "0NSJ243206261600932123" }, { "name": "IdCard", "type": "string", "required": false, "description": "身份标识。 - 未使用OCR服务时，必须传入。 - 规则：a-z，A-Z，0-9组合。 - 最长长度32位。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": false, "description": "姓名。 - 未使用OCR服务时，必须传入。 - 最长长度32位。 - 中文请使用UTF-8编码。", "example": "韦小宝" }, { "name": "Extra", "type": "string", "required": false, "description": "透传字段，在获取验证结果时返回。 - 最长长度1024位。", "example": "202411011707591990200060000" }, { "name": "Config", "type": "object", "required": false, "description": "小程序模式配置，包括如何传入姓名身份证的配置，以及是否使用意愿核身。", "example": "无", "children": [ { "name": "InputType", "type": "string", "required": false, "description": "姓名身份证输入方式。 - 取值范围： 1：传身份证正反面OCR。 2：传身份证正面OCR。 3：用户手动输入。 4：客户后台传入。 - 默认值：1。 - 注意：使用OCR时仅支持用户修改结果中的姓名。", "example": "1" }, { "name": "UseIntentionVerify", "type": "boolean", "required": false, "description": "是否使用意愿核身。 - 默认不使用。 - 注意：如开启使用，则计费标签按【意愿核身】计费标签计价；如不开启，则计费标签按【E证通】计费标签计价，价格详见：[价格说明](https://cloud.tencent.com/document/product/1007/56804)。", "example": "true" }, { "name": "IntentionMode", "type": "string", "required": false, "description": "意愿核身模式。 - 取值范围： 1：语音朗读模式。 2：语音问答模式。 3：点头确认模式。 - 默认值为1。", "example": "1" }, { "name": "IntentionVerifyText", "type": "string", "required": false, "description": "意愿核身朗读模式使用的文案。 - 若未使用意愿核身朗读功能，该字段无需传入。 - 默认为空，最长可接受120的字符串长度。", "example": "\"请阅读\"" }, { "name": "IntentionQuestions", "type": "array", "required": false, "description": "意愿核身问答模式的配置列表。 - 问答模式支持1-10轮（不超过10轮）的意愿确认。", "example": "无", "item_type": "object", "children": [ { "name": "Question", "type": "string", "required": true, "description": "当选择语音问答模式时，系统自动播报的问题文本。 - 最大长度为250个字符。", "example": "请问您本次业务是本人自愿办理吗？如是，请回复“我同意”。" }, { "name": "Answers", "type": "array", "required": true, "description": "当选择语音问答模式时，用于判断用户回答是否通过的标准答案列表。 - 传入后可自动判断用户回答文本是否在标准文本列表中。 - 列表长度最大为50，单个答案长度限制10个字符。", "example": "[\"同意\", \"我同意\", \"确认\", \"我确认\"]", "item_type": "string" } ] }, { "name": "IntentionActions", "type": "array", "required": false, "description": "意愿核身（点头确认模式）使用的文案。 - 若未使用意愿核身（点头确认模式），则该字段无需传入。 - 默认为空，最长可接受150的字符串长度。 - 点头确认模式支持1-10轮（不超过10轮）的意愿确认。", "example": "无", "item_type": "object", "children": [ { "name": "Text", "type": "string", "required": true, "description": "点头确认模式下，系统语音播报使用的问题文本，问题最大长度为250个字符。", "example": "请问您本次业务是本人自愿办理吗？如是，请点头确认。" } ] }, { "name": "IntentionRecognition", "type": "boolean", "required": false, "description": "意愿核身过程中识别用户的回答意图。 - 开启后除了IntentionQuestions的Answers列表中的标准回答会通过，近似意图的回答也会通过。 - 默认开启。", "example": "true" }, { "name": "IsSupportHMTResidentPermitOCR", "type": "boolean", "required": false, "description": "是否支持港澳台居住证识别。", "example": "false" }, { "name": "MouthOpenRecognition", "type": "boolean", "required": false, "description": "用户语音回答过程中是否开启张嘴识别检测。 - 默认不开启。 - 仅在意愿核身问答模式中使用。", "example": "false" }, { "name": "Speed", "type": "integer", "required": false, "description": "意愿核身语音播报速度。 - 配置后问答模式和点头模式的语音播报环节都会生效。 - 默认值为0。 - 取值范围： 0：智能语速（根据播报文案的长度自动调整语音播报速度）。 1：固定1倍速。 2：固定1.2倍速。 3：固定1.5倍速。", "example": "0" } ] }, { "name": "RedirectUrl", "type": "string", "required": false, "description": "用户从Url中进入核身认证结束后重定向的回调链接地址。 - 最长长度1024位。 - EidToken会在该链接的query参数中。", "example": "https://faceid.qq.com" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "MerchantId" ] }, { "name": "GetFaceIdResult", "description": "完成验证后，用FaceIdToken调用本接口获取结果信息，FaceIdToken生成后三天内（3\\*24\\*3,600秒）可多次拉取。", "status": "online", "parameters": [ { "name": "FaceIdToken", "type": "string", "required": true, "description": "SDK人脸核身流程的标识。 - 调用[GetFaceIdToken](https://cloud.tencent.com/document/product/1007/49198)接口时生成。", "example": "CE6613F1A-0F1E-45BD-BE13-34C05CEA76181" }, { "name": "IsNeedVideo", "type": "boolean", "required": false, "description": "是否需要拉取视频。 - 默认false：不需要。", "example": "false" }, { "name": "IsNeedBestFrame", "type": "boolean", "required": false, "description": "是否需要拉取截帧。 - 默认false：不需要。", "example": "false" }, { "name": "IsEncryptResponse", "type": "boolean", "required": false, "description": "是否对回包整体进行加密。", "example": "false" }, { "name": "Encryption", "type": "object", "required": false, "description": "是否需要对返回中的敏感信息进行加密。只需指定加密算法Algorithm即可，其余字段传入默认值。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "FaceIdToken" ] }, { "name": "GetFaceIdRiskInfo", "description": "完成验证后，用FaceIdToken调用本接口获取设备风险相关信息，FaceIdToken生成后三天内（3\\*24\\*3,600秒）可多次拉取。", "status": "online", "parameters": [ { "name": "FaceIdToken", "type": "string", "required": true, "description": "SDK人脸核身流程的标识，调用[GetFaceidRiskInfoToken](https://cloud.tencent.com/document/product/1007/104581)接口时生成。", "example": "CE6621F1A-0F1E-45BD-BE13-34C025CEA7681" } ], "required": [ "FaceIdToken" ] }, { "name": "GetFaceIdToken", "description": "每次调用人脸核身SDK服务前，需先调用本接口获取SDKToken，用来串联核身流程，在验证完成后，用于获取验证结果信息，该token仅能核身一次。", "status": "online", "parameters": [ { "name": "CompareLib", "type": "string", "required": true, "description": "比对库。 - 取值范围： LOCAL：本地上传照片。 BUSINESS：商业库。", "example": "BUSINESS" }, { "name": "IdCard", "type": "string", "required": false, "description": "身份证。 - CompareLib为商业库时必传。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": false, "description": "姓名。 - CompareLib为商业库时必传。", "example": "韦小宝" }, { "name": "ImageBase64", "type": "string", "required": false, "description": "图片的Base64。 - CompareLib为上传照片比对时必传。 - Base64后图片最大8MB。 - 请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。", "example": "/9j/4AAQSkZJRg.....s97n//2Q==" }, { "name": "Meta", "type": "string", "required": false, "description": "SDK中生成的Meta字符串。", "example": "无" }, { "name": "Extra", "type": "string", "required": false, "description": "透传参数。 - 1000长度字符串", "example": "无" }, { "name": "UseCos", "type": "boolean", "required": false, "description": "是否使用cos桶。 - 默认为false。 - 设置该参数为true后，核身过程中的视频图片将会存储在人脸核身控制台授权cos的bucket中，拉取结果时会返回对应资源完整cos地址。 - 开通地址见https://console.cloud.tencent.com/faceid/cos - 【注意】选择该参数为true后将不返回base64数据，请根据接入情况谨慎修改。", "example": "true" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。对传入信息（姓名、身份证号、自传照片）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] }, { "name": "RuleId", "type": "string", "required": false, "description": "用于细分客户使用场景。 - 申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。 - 如有疑问，请添加腾讯云人脸核身小助手进行咨询。", "example": "12" } ], "required": [ "CompareLib" ] }, { "name": "GetFaceidRiskInfoToken", "description": "每次调用人脸核身SDK服务前，需先调用本接口获取SDKToken，用来串联核身流程，在验证完成后，用于获取风险结果信息，该Token仅能核身一次。", "status": "online", "parameters": [ { "name": "Meta", "type": "string", "required": false, "description": "SDK中生成的Meta字符串。", "example": "\"\"" }, { "name": "Extra", "type": "string", "required": false, "description": "透传参数 1000长度字符串。", "example": "\"\"" } ], "required": [] }, { "name": "GetLiveCode", "description": "使用数字活体检测模式前，需调用本接口获取数字验证码。", "status": "online", "parameters": [], "required": [] }, { "name": "GetWeChatBillDetails", "description": "查询微信渠道服务（微信小程序、微信原生H5、微信普通H5）的账单明细及计费状态。", "status": "online", "parameters": [ { "name": "Date", "type": "string", "required": true, "description": "拉取的日期（YYYY-MM-DD）。 - 最大可追溯到365天前。 - 当天6点后才能拉取前一天的数据。", "example": "2023-03-01" }, { "name": "Cursor", "type": "integer", "required": true, "description": "游标。 - 用于分页。 - 取第一页时传0，取后续页面时，传入本接口响应中返回的NextCursor字段的值。", "example": "1" }, { "name": "RuleId", "type": "string", "required": false, "description": "需要拉取账单详情业务对应的RuleId。 - 不传会返回所有RuleId数据。 - 默认为空字符串。", "example": "12" } ], "required": [ "Date", "Cursor" ] }, { "name": "IdCardOCRVerification", "description": "本接口用于校验姓名和身份证号的真实性和一致性，您可以通过输入姓名和身份证号或传入身份证人像面照片提供所需验证信息。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": false, "description": "身份证号。 - 姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。 - 若都提供了，则按照姓名和身份证号\u003eImageBase64\u003eImageUrl的优先级使用参数。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": false, "description": "姓名。", "example": "韦小宝" }, { "name": "ImageBase64", "type": "string", "required": false, "description": "身份证人像面的 Base64 值。 - 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 - 支持的图片大小：所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。", "example": "/9j/4AAQSkZJRg.....s97n//2Q==" }, { "name": "ImageUrl", "type": "string", "required": false, "description": "身份证人像面的 Url 地址。 - 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。 - 支持的图片大小：所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。 - 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。 - 非腾讯云存储的 Url 速度和稳定性可能受一定影响。", "example": "https://www.qq.com/image.jpg" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [] }, { "name": "IdCardVerification", "description": "传入姓名和身份证号，校验两者的真实性和一致性。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "IdCard", "Name" ] }, { "name": "ImageRecognition", "description": "传入照片和身份信息，判断该照片与权威库的证件照是否属于同一个人（该接口已停止接入，新客户请使用照片人脸核身（V2.0）接口）。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。中文请使用UTF-8编码。", "example": "韦小宝" }, { "name": "ImageBase64", "type": "string", "required": true, "description": "用于人脸比对的照片，图片的Base64值；Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。", "example": "\u003cImageBase64\u003e" }, { "name": "Optional", "type": "string", "required": false, "description": "本接口不需要传递此参数。", "example": "92424b" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "IdCard", "Name", "ImageBase64" ] }, { "name": "ImageRecognitionV2", "description": "传入照片和身份信息，判断该照片与权威库的证件照是否属于同一个人。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。中文请使用UTF-8编码。", "example": "韦小宝" }, { "name": "ImageBase64", "type": "string", "required": true, "description": "用于人脸比对的照片，图片的Base64值；Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。", "example": "/9j/4AAQSkZJRg.....s97n//2Q==" }, { "name": "Optional", "type": "string", "required": false, "description": "本接口不需要传递此参数。", "example": "92424b" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] }, { "name": "Extra", "type": "string", "required": false, "description": "自定义描述字段。用于描述调用业务信息，出参中将返回此描述字段。每个自定义描述字段支持[1,10]个字符。", "example": "开户业务" } ], "required": [ "IdCard", "Name", "ImageBase64" ] }, { "name": "LivenessCompare", "description": "传入视频和照片，先判断视频中是否为真人，判断为真人后，再判断该视频中的人与上传照片是否属于同一个人。", "status": "online", "parameters": [ { "name": "LivenessType", "type": "string", "required": true, "description": "活体检测类型。取值：LIP/ACTION/SILENT。LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。", "example": "LIP" }, { "name": "ImageBase64", "type": "string", "required": false, "description": "用于人脸比对的照片的Base64值。Base64编码后的图片数据大小不超过3M，仅支持jpg、png格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageBase64。", "example": "/9j/4AAQSkZJRg.....s97n//2Q==" }, { "name": "ImageUrl", "type": "string", "required": false, "description": "用于人脸比对照片的URL地址。图片下载后经Base64编码后的数据大小不超过3M，仅支持jpg、png格式。图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageBase64。图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。", "example": "http://www.qq.com/image.jpg" }, { "name": "ValidateData", "type": "string", "required": false, "description": "验证数据。数字模式传参：传数字验证码，验证码需先调用获取数字验证码接口得到；动作模式传参：传动作顺序，动作顺序需先调用获取动作顺序接口得到；静默模式传参：空。", "example": "2,1" }, { "name": "Optional", "type": "string", "required": false, "description": "额外配置，传入JSON字符串。格式如下：{\u0026quot;BestFrameNum\u0026quot;: 2 //需要返回多张最佳截图，取值范围2-10}", "example": "{\\\"BestFrameNum\\\":1}" }, { "name": "VideoBase64", "type": "string", "required": false, "description": "用于活体检测的视频，视频的Base64值。Base64编码后的大小不超过8M，支持mp4、avi、flv格式。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。", "example": "AAAAIGZ0eX...0tLS0tLS8=" }, { "name": "VideoUrl", "type": "string", "required": false, "description": "用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M，视频下载耗时不超过4S，支持mp4、avi、flv格式。视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。", "example": "http://www.qq.com/video.mp4" } ], "required": [ "LivenessType" ] }, { "name": "LivenessRecognition", "description": "传入视频和身份信息，先判断视频中是否为真人，判断为真人后，再判断该视频中的人与权威库的证件照是否属于同一个人。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。中文请使用UTF-8编码。", "example": "韦小宝" }, { "name": "LivenessType", "type": "string", "required": true, "description": "活体检测类型。取值：LIP/ACTION/SILENT。LIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。", "example": "SILENT" }, { "name": "VideoBase64", "type": "string", "required": false, "description": "用于活体检测的视频，视频的BASE64值；BASE64编码后的大小不超过8M，支持mp4、avi、flv格式。", "example": "AAAAIGZ0eX...0tLS0tLS8=" }, { "name": "VideoUrl", "type": "string", "required": false, "description": "用于活体检测的视频Url 地址。视频下载后经Base64编码不超过 8M，视频下载耗时不超过4S，支持mp4、avi、flv格式。视频的 VideoUrl、VideoBase64 必须提供一个，如果都提供，只使用 VideoBase64。建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。", "example": "http://www.qq.com/video.mp4" }, { "name": "ValidateData", "type": "string", "required": false, "description": "验证数据。数字活体模式传参：传数字验证码，验证码需先调用获取数字验证码接口得到；动作活体模式传参：传动作顺序，动作顺序需先调用获取动作顺序接口得到；静默活体模式传参：空。", "example": "4903" }, { "name": "Optional", "type": "string", "required": false, "description": "额外配置，传入JSON字符串。格式如下：{\u0026quot;BestFrameNum\u0026quot;: 2 //需要返回多张最佳截图，取值范围2-10}", "example": "{\\\"BestFrameNum\\\":1}" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。对传入信息（姓名、身份证号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "IdCard", "Name", "LivenessType" ] }, { "name": "MinorsVerification", "description": "通过传入手机号或姓名和身份证号，结合权威数据源和腾讯健康守护可信模型，判断该信息是否真实且年满18周岁。腾讯健康守护可信模型覆盖了上十亿手机库源，覆盖率高、准确率高，如果不在库中的手机号，还可以通过姓名+身份证进行兜底验证。", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "参与校验的参数类型。 0：使用手机号进行校验； 1：使用姓名与身份证号进行校验。", "example": "0" }, { "name": "Mobile", "type": "string", "required": false, "description": "手机号，11位数字，特别提示：手机号验证只限制在腾讯健康守护可信模型覆盖的数据范围内，与手机号本身在运营商是否实名无关联，不在范围会提示“手机号未实名”，建议客户与传入姓名和身份证号信息组合使用。", "example": "16137688175" }, { "name": "IdCard", "type": "string", "required": false, "description": "身份证号码。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": false, "description": "姓名。", "example": "韦小宝" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。对传入信息（姓名、身份证号、手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "Type" ] }, { "name": "MobileNetworkTimeVerification", "description": "本接口用于查询手机号在网时长，输入手机号进行查询。", "status": "online", "parameters": [ { "name": "Mobile", "type": "string", "required": true, "description": "手机号码。", "example": "16137688175" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "Mobile" ] }, { "name": "MobileStatus", "description": "本接口用于验证手机号的状态，您可以输入手机号进行查询。", "status": "online", "parameters": [ { "name": "Mobile", "type": "string", "required": true, "description": "手机号码。", "example": "16137688175" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "Mobile" ] }, { "name": "ParseNfcData", "description": "解析SDK获取到的证件NFC数据，接口传入SDK返回的ReqId，返回证件信息（个别字段为特定证件类型特有）。SDK生成的ReqId五分钟内有效，重复查询仅收一次费。支持身份证类证件（二代身份证、港澳居住证、台湾居住证、外国人永居证）以及旅行类证件（港澳通行证、台湾通行证、台胞证、回乡证）的NFC识别及核验。", "status": "online", "parameters": [ { "name": "ReqId", "type": "string", "required": true, "description": "前端SDK返回。", "example": "ECBEC11E6-F05A-40DE-9CC3-C9EF119F55FE1" } ], "required": [ "ReqId" ] }, { "name": "PhoneVerification", "description": "本接口用于校验手机号、姓名和身份证号的真实性和一致性。支持的手机号段详情请查阅运营商类文档。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号。", "example": "16137688175" }, { "name": "VerifyMode", "type": "string", "required": false, "description": "验证模式（详版/简版）。 - 简版与详版价格不一致，详见[价格说明](https://cloud.tencent.com/document/product/1007/84321)。 - 枚举值：0（简版）；1（详版）。 - 默认值为0。", "example": "0" }, { "name": "CiphertextBlob", "type": "string", "required": false, "description": "有加密需求的用户，传入kms的CiphertextBlob。关于数据加密可查阅数据加密文档。", "example": "BKD5+E/euB3mXQ9pqKNLvazmrSB/XdTsOasrx+m......UY7JJ7p/WTFirTINnU4=" }, { "name": "EncryptList", "type": "array", "required": false, "description": "在使用加密服务时，填入要被加密的字段。 - 本接口中可填入加密后的IdCard，Name，Phone中的一个或多个。", "example": "[IdCard]", "item_type": "string" }, { "name": "Iv", "type": "string", "required": false, "description": "有加密需求的用户，传入CBC加密的初始向量。", "example": "+am/h1FrULT8Y39M" } ], "required": [ "IdCard", "Name", "Phone" ] }, { "name": "PhoneVerificationCMCC", "description": "本接口用于校验中国移动手机号、姓名和身份证号的真实性和一致性。中国移动支持的手机号段详情请查阅运营商类文档。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号。", "example": "16137688175" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号、手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "IdCard", "Name", "Phone" ] }, { "name": "PhoneVerificationCTCC", "description": "本接口用于校验中国电信手机号、姓名和身份证号的真实性和一致性。中国电信支持的手机号段详情请查阅运营商类文档。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号。", "example": "16137688175" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号、手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "IdCard", "Name", "Phone" ] }, { "name": "PhoneVerificationCUCC", "description": "本接口用于校验中国联通手机号、姓名和身份证号的真实性和一致性。中国联通支持的手机号段详情请查阅运营商类文档。", "status": "online", "parameters": [ { "name": "IdCard", "type": "string", "required": true, "description": "身份证号。", "example": "11204416541220243X" }, { "name": "Name", "type": "string", "required": true, "description": "姓名。", "example": "韦小宝" }, { "name": "Phone", "type": "string", "required": true, "description": "手机号。", "example": "16137688175" }, { "name": "Encryption", "type": "object", "required": false, "description": "敏感数据加密信息。 - 对传入信息（姓名、身份证号、手机号）有加密需求的用户可使用此参数，详情请点击左侧链接。", "example": "无", "children": [ { "name": "EncryptList", "type": "array", "required": true, "description": "在使用加密服务时，填入要被加密的字段。本接口中可填入加密后的一个或多个字段注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" }, { "name": "CiphertextBlob", "type": "string", "required": true, "description": "加密后的对称密钥，关于密钥的生成和使用请查阅数据加密文档。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Iv", "type": "string", "required": true, "description": "有加密需求的用户，传入CBC加密的初始向量（客户自定义字符串，长度16字符）。注意：此字段可能返回 null，表示取不到有效值。", "example": "null" }, { "name": "Algorithm", "type": "string", "required": false, "description": "加密使用的算法（支持\u0026#39;AES-256-CBC\u0026#39;、\u0026#39;SM4-GCM\u0026#39;），不传默认为\u0026#39;AES-256-CBC\u0026#39; 注意：此字段可能返回 null，表示取不到有效值。", "example": "SM4-GCM" }, { "name": "TagList", "type": "array", "required": false, "description": "SM4-GCM算法生成的消息摘要（校验消息完整性时使用）注意：此字段可能返回 null，表示取不到有效值。", "example": "[\"string\"]", "item_type": "string" } ] } ], "required": [ "IdCard", "Name", "Phone" ] } ] }