{ "openapi": "3.0.3", "info": { "title": "腾讯云-人脸核身", "description": "依托于证件OCR识别、活体检测、1：1人脸比对等AI技术，实现自然人真实身份核验的产品。秒级确认用户身份，帮助提升业务办理效率，降低人力成本。", "termsOfService": "https://www.showapi.com/helpcenter/view#/4019/2", "version": "1.0.0" }, "servers": [ { "url": "https://route.showapi.com" } ], "paths": { "/2547-20": { "x-pointCode": 20, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "手机号三要素核验", "description": "本接口用于校验手机号、姓名和身份证号的真实性和一致性。支持的手机号段详情请查阅运营商类文档。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码:\n收费结果码\n0: 认证通过\n-4: 信息不一致（手机号已实名，但姓名和身份证号与实名信息不一致）\n-5: 手机号未实名\n不收费结果码\n-6: 手机号码不合法\n-7: 身份证号码有误\n-8: 姓名校验不通过\n-9: 没有记录\n-10: 认证未通过\n-11: 验证中心服务繁忙" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_20_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "Name": { "type": "string", "description": "姓名" }, "Phone": { "type": "string", "description": "手机号" }, "IdCard": { "type": "string", "description": "身份证号" } }, "required": [ "ds_id", "Name", "Phone", "IdCard" ] } } } } } }, "/2547-19": { "x-pointCode": 19, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "手机号状态查询", "description": "本接口用于验证手机号的状态，您可以输入手机号进行查询。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码，收费情况如下。\n收费结果码：\n0：成功\n不收费结果码：\n-1：未查询到结果\n-2：手机号格式不正确\n-3：验证中心服务繁忙" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "StatusCode": { "type": "string", "description": "状态码：\n0：正常\n1：停机\n2：销号\n3：空号\n4：不在网\n99：未知状态" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_19_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "Mobile": { "type": "string", "description": "手机号" } }, "required": [ "ds_id", "Mobile" ] } } } } } }, "/2547-18": { "x-pointCode": 18, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "未成年人守护", "description": "未成年人守护接口是通过传入手机号或姓名和身份证号，结合权威数据源和腾讯健康守护可信模型，判断该信息是否真实且年满18周岁。腾讯健康守护可信模型覆盖了上十亿手机库源，覆盖率高、准确率高，如果不在库中的手机号，还可以通过姓名+身份证进行兜底验证。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "结果码，收费情况如下。\n收费结果码：\n0: 成年\n-1: 未成年\n-3: 姓名和身份证号不一致\n\n不收费结果码：\n-2: 未查询到手机号信息\n-4: 非法身份证号（长度、校验位等不正确）\n-5: 非法姓名（长度、格式等不正确）\n-6: 权威数据源服务异常\n-7: 未查询到身份信息\n-8: 权威数据源升级中，请稍后再试" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "AgeRange": { "type": "string", "description": "该字段的值为年龄区间。格式为[a,b)，\n[0,8)表示年龄小于8周岁区间，不包括8岁；\n[8,16)表示年龄8-16周岁区间，不包括16岁；\n[16,18)表示年龄16-18周岁区间，不包括18岁；\n[18,+)表示年龄大于18周岁。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_18_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "IdCard": { "type": "string", "description": "身份证号" }, "Name": { "type": "string", "description": "姓名" }, "Mobile": { "type": "string", "description": "手机号，11位数字，\n特别提示：\n手机号验证只限制在腾讯健康守护可信模型覆盖的数据范围内，与手机号本身在运营商是否实名无关联，不在范围会提示“手机号未实名”，建议客户与传入姓名和身份证号信息组合使用。" }, "Type": { "type": "string", "description": "参与校验的参数类型。\n0：使用手机号进行校验；\n1：使用姓名与身份证号进行校验。" } }, "required": [ "ds_id" ] } } } } } }, "/2547-17": { "x-pointCode": 17, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "身份证识别及信息核验", "description": "本接口用于校验姓名和身份证号的真实性和一致性，您可以通过输入姓名和身份证号或传入身份证人像面照片提供所需验证信息。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码，收费情况如下。\n收费结果码：\n0: 姓名和身份证号一致\n-1: 姓名和身份证号不一致\n不收费结果码：\n-2: 非法身份证号（长度、校验位等不正确）\n-3: 非法姓名（长度、格式等不正确）\n-4: 证件库服务异常\n-5: 证件库中无此身份证记录" }, "Description": { "type": "string", "description": "业务结果描述。" }, "Name": { "type": "string", "description": "用于验证的姓名" }, "IdCard": { "type": "string", "description": "用于验证的身份证号" }, "Sex": { "type": "string", "description": "OCR得到的性别\n注意：此字段可能返回 null，表示取不到有效值。" }, "Nation": { "type": "string", "description": "OCR得到的民族\n注意：此字段可能返回 null，表示取不到有效值。" }, "Birth": { "type": "string", "description": "OCR得到的生日\n注意：此字段可能返回 null，表示取不到有效值。" }, "Address": { "type": "string", "description": "OCR得到的地址\n注意：此字段可能返回 null，表示取不到有效值。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_17_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "ImageBase64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "身份证人像面的 Base64 值\n支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。\n支持的图片大小：所下载图片经Base64编码后不超过 3M。请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。" }, "ImageUrl": { "type": "string", "description": "身份证人像面的 Url 地址\n支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。\n支持的图片大小：所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。\n图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的 Url 速度和稳定性可能受一定影响。" }, "IdCard": { "type": "string", "description": "身份证号\n姓名和身份证号、ImageBase64、ImageUrl三者必须提供其中之一。若都提供了，则按照姓名和身份证号>ImageBase64>ImageUrl的优先级使用参数。" }, "Name": { "type": "string", "description": "姓名" } }, "required": [ "ds_id" ] } } } } } }, "/2547-16": { "x-pointCode": 16, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "身份证人像照片验真", "description": "传入身份证人像面照片，识别身份证照片上的信息，并将姓名、身份证号、身份证人像照片与公安权威库的证件照进行比对，是否属于同一个人，从而验证身份证信息的真实性。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "ret_code": { "type": "number" }, "remark": { "type": "string" }, "Response": { "type": "object", "properties": { "Address": { "type": "string", "description": "地址" }, "Birth": { "type": "string", "description": "出生日期" }, "Description": { "type": "string", "description": "业务结果描述。" }, "IdNum": { "type": "string", "description": "身份证号" }, "Name": { "type": "string", "description": "姓名" }, "Nation": { "type": "string", "description": "民族" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "Result": { "type": "string", "description": "业务错误码，成功情况返回Success, 错误情况请参考下方错误码列表中FailedOperation部分" }, "Sex": { "type": "string", "description": "性别" }, "Sim": { "type": "number", "description": "相似度，取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人，可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一）" }, "Portrait": { "type": "string", "description": "身份证头像照片的base64编码，如果抠图失败会拿整张身份证做比对并返回空。" }, "Warnings": { "type": "string", "description": "告警信息，当在Config中配置了告警信息会停止人像比对，Result返回错误（FailedOperation.OcrWarningOccurred）并有此告警信息，Code 告警码列表和释义：\n\n-9101 身份证边框不完整告警，\n-9102 身份证复印件告警，\n-9103 身份证翻拍告警，\n-9105 身份证框内遮挡告警，\n-9104 临时身份证告警，\n-9106 身份证 PS 告警。\n-8001 图片模糊告警\n多个会 | 隔开如 \"-9101|-9106|-9104\"" }, "Quality": { "type": "number", "description": "图片质量分数，当请求Config中配置图片模糊告警该参数才有意义，取值范围（0～100），目前默认阈值是50分，低于50分会触发模糊告警。" } } } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_16_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "ImageBase64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "身份证人像面的 Base64 值\n支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。\n支持的图片大小：所下载图片经Base64编码后不超过 7M。\n请使用标准的Base64编码方式(带=补位)，编码规范参考RFC4648。\nImageBase64、ImageUrl二者必须提供其中之一。若都提供了，则按照ImageUrl>ImageBase64的优先级使用参数。" }, "ImageUrl": { "type": "string", "description": "身份证人像面的 Url 地址\n支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。\n支持的图片大小：所下载图片经 Base64 编码后不超过 3M。图片下载时间不超过 3 秒。\n图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。\n非腾讯云存储的 Url 速度和稳定性可能受一定影响。" } }, "required": [ "ds_id" ] } } } } } }, "/2547-15": { "x-pointCode": 15, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "手机号二要素核验", "description": "手机号二要素核验接口用于校验手机号和姓名的真实性和一致性，支持的手机号段详情请查阅运营商类文档。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码，收费情况如下。\n收费结果码：\n0: 验证结果一致\n1: 验证结果不一致\n不收费结果码：\n-1:查无记录\n-2:引擎未知错误\n-3:引擎服务异常" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_15_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "Name": { "type": "string", "description": "姓名" }, "Mobile": { "type": "string", "description": "手机号" } }, "required": [ "ds_id", "Name", "Mobile" ] } } } } } }, "/2547-14": { "x-pointCode": 14, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "银行卡基础信息查询", "description": "银行卡基础信息查询", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码，收费情况如下。\n收费结果码：\n0: 查询成功\n-1: 未查到信息\n不收费结果码\n-2：验证中心服务繁忙\n-3：银行卡不存在" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "AccountBank": { "type": "string", "description": "开户行" }, "AccountType": { "type": "string", "description": "卡性质：1. 借记卡；2. 贷记卡" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_14_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "BankCard": { "type": "string", "description": "银行卡" } }, "required": [ "ds_id", "BankCard" ] } } } } } }, "/2547-13": { "x-pointCode": 13, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "手机号在网时长核验", "description": "本接口用于查询手机号在网时长，输入手机号进行查询。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码，收费情况如下。\n收费结果码：\n0: 成功\n-2: 手机号不存在\n-3: 手机号存在，但无法查询到在网时长\n不收费结果码：\n-1: 手机号格式不正确\n-4: 验证中心服务繁忙" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" }, "Range": { "type": "string", "description": "在网时长区间。\n格式为(a,b]，表示在网时长在a个月以上，b个月以下。若b为+时表示没有上限。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_13_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "Mobile": { "type": "string", "description": "手机号" } }, "required": [ "ds_id", "Mobile" ] } } } } } }, "/2547-12": { "x-pointCode": 12, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "获取实名核身结果信息", "description": "完成验证后，用BizToken调用本接口获取结果信息，BizToken生成后三天内（3*24*3,600秒）可多次拉取。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "DetectInfo": { "type": "string", "description": "JSON字符串。\n{\n// 文本类信息\n\"Text\": {\n\"ErrCode\": null, // 本次核身最终结果。0为成功\n\"ErrMsg\": null, // 本次核身最终结果信息描述。\n\"IdCard\": \"\", // 本次核身最终获得的身份证号。\n\"Name\": \"\", // 本次核身最终获得的姓名。\n\"OcrNation\": null, // ocr阶段获取的民族\n\"OcrAddress\": null, // ocr阶段获取的地址\n\"OcrBirth\": null, // ocr阶段获取的出生信息\n\"OcrAuthority\": null, // ocr阶段获取的证件签发机关\n\"OcrValidDate\": null, // ocr阶段获取的证件有效期\n\"OcrName\": null, // ocr阶段获取的姓名\n\"OcrIdCard\": null, // ocr阶段获取的身份证号\n\"OcrGender\": null, // ocr阶段获取的性别\n\"LiveStatus\": null, // 活体检测阶段的错误码。0为成功\n\"LiveMsg\": null, // 活体检测阶段的错误信息\n\"Comparestatus\": null,// 一比一阶段的错误码。0为成功\n\"Comparemsg\": null, // 一比一阶段的错误信息\n\"Location\": null, // 地理位置信息\n\"Extra\": \"\", // DetectAuth结果传进来的Extra信息\n\"Detail\": { // 活体一比一信息详情\n\"LivenessData\": []\n}\n},\n// 身份证正反面照片Base64\n\"IdCardData\": {\n\"OcrFront\": null,\n\"OcrBack\": null\n},\n// 视频最佳帧截图Base64\n\"BestFrame\": {\n\"BestFrame\": null\n},\n// 活体视频Base64\n\"VideoData\": {\n\"LivenessVideo\": null\n}\n}" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_12_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "BizToken": { "type": "string", "description": "人脸核身流程的标识，调用DetectAuth接口时生成。" }, "RuleId": { "type": "string", "description": "用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请加慧眼小助手微信（faceid001）进行咨询。" }, "InfoType": { "type": "string", "description": "指定拉取的结果信息，取值（0：全部；1：文本类；2：身份证正反面；3：视频最佳截图照片；4：视频）。\n如 134表示拉取文本类、视频最佳截图照片、视频。" } }, "required": [ "ds_id", "BizToken", "RuleId" ] } } } } } }, "/2547-11": { "x-pointCode": 11, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "实名核身鉴权", "description": "每次调用人脸核身SaaS化服务前，需先调用本接口获取BizToken，用来串联核身流程，在验证完成后，用于获取验证结果信息。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "BizToken": { "type": "string", "description": "一次核身流程的标识，有效时间为7,200秒；\n完成核身后，可用该标识获取验证结果信息。" }, "Url": { "type": "string", "description": "用于发起核身流程的URL，仅微信H5场景使用。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_11_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "RuleId": { "type": "string", "description": "用于细分客户使用场景，申请开通服务后，可以在腾讯云慧眼人脸核身控制台（https://console.cloud.tencent.com/faceid）自助接入里面创建，审核通过后即可调用。如有疑问，请加慧眼小助手微信（faceid001）进行咨询。" }, "IdCard": { "type": "string", "description": "身份标识（与公安权威库比对时必须是身份证号）。\n规则：a-zA-Z0-9组合。最长长度32位。" }, "Name": { "type": "string", "description": "姓名。最长长度32位。中文请使用UTF-8编码。" }, "RedirectUrl": { "type": "string", "description": "认证结束后重定向的回调链接地址。最长长度1024位。" }, "Extra": { "type": "string", "description": "透传字段，在获取验证结果时返回。" }, "ImageBase64": { "type": "string", "minLength": 0, "maxLength": 100000000, "description": "用于人脸比对的照片，图片的BASE64值；\nBASE64编码后的图片数据大小不超过3M，仅支持jpg、png格式。" } }, "required": [ "ds_id", "RuleId" ] } } } } } }, "/2547-10": { "x-pointCode": 10, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "活体人脸核身", "description": "传入视频和身份信息，先判断视频中是否为真人，判断为真人后，再判断该视频中的人与公安权威库的证件照是否属于同一个人。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "业务错误码，成功情况返回Success, 错误情况请参考下方错误码列表中FailedOperation部分" }, "Description": { "type": "string", "description": "业务错误描述" }, "BestFrameBase64": { "type": "string", "description": "验证通过后的视频最佳截图照片，照片为BASE64编码后的值，jpg格式。" }, "Sim": { "type": "string", "description": "相似度，取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人，可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一）" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_10_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "IdCard": { "type": "string", "description": "身份证号" }, "Name": { "type": "string", "description": "姓名。中文请使用UTF-8编码。" }, "VideoBase64": { "type": "string", "minLength": 0, "maxLength": 100000000, "description": "用于活体检测的视频，视频的BASE64值；\nBASE64编码后的大小不超过5M，支持mp4、avi、flv格式。" }, "LivenessType": { "type": "string", "description": "活体检测类型，取值：LIP/ACTION/SILENT。\nLIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。" }, "ValidateData": { "type": "string", "description": "数字模式传参：数字验证码(1234)，需先调用接口获取数字验证码；\n动作模式传参：传动作顺序(2,1 or 1,2)，需先调用接口获取动作顺序；\n静默模式传参：空。" } }, "required": [ "ds_id", "IdCard", "Name", "VideoBase64", "LivenessType" ] } } } } } }, "/2547-9": { "x-pointCode": 9, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "活体人脸比对", "description": "传入视频和照片，先判断视频中是否为真人，判断为真人后，再判断该视频中的人与上传照片是否属于同一个人", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "业务错误码，成功情况返回Success, 错误情况请参考下方错误码列表中FailedOperation部分" }, "Description": { "type": "string", "description": "业务错误描述" }, "BestFrameBase64": { "type": "string", "description": "验证通过后的视频最佳截图照片，照片为BASE64编码后的值，jpg格式。\n" }, "Sim": { "type": "string", "description": "相似度，取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人，可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一）。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_9_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "ImageBase64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "用于人脸比对的照片，图片的BASE64值；\nBASE64编码后的图片数据大小不超过3M，仅支持jpg、png格式。" }, "VideoBase64": { "type": "string", "minLength": 0, "maxLength": 100000000, "description": "用于活体检测的视频，视频的BASE64值；\nBASE64编码后的大小不超过5M，支持mp4、avi、flv格式。" }, "LivenessType": { "type": "string", "description": "活体检测类型，取值：LIP/ACTION/SILENT。\nLIP为数字模式，ACTION为动作模式，SILENT为静默模式，三种模式选择一种传入。" }, "ValidateData": { "type": "string", "description": "数字模式传参：数字验证码(1234)，需先调用接口获取数字验证码；\n动作模式传参：传动作顺序(2,1 or 1,2)，需先调用接口获取动作顺序；\n静默模式传参：空。" } }, "required": [ "ds_id", "ImageBase64", "VideoBase64", "LivenessType" ] } } } } } }, "/2547-7": { "x-pointCode": 7, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "照片人脸核身", "description": "传入照片和身份信息，判断该照片与公安权威库的证件照是否属于同一个人。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "业务错误码，成功情况返回Success, 错误情况请参考下方错误码列表中FailedOperation部分、\n\nFailedOperation.CompareFail\t比对失败。\nFailedOperation.CompareLowSimilarity\t比对相似度未达到通过标准。\nFailedOperation.CompareSystemError\t调用比对引擎接口出错。\nFailedOperation.FileSaveError\t文件存储失败，请稍后重试。\nFailedOperation.IdFormatError\t输入的身份证号有误。\nFailedOperation.IdNameMisMatch\t姓名和身份证号不一致，请核实后重试。\nFailedOperation.IdNoExistSystem\t库中无此号，请到户籍所在地进行核实。\nFailedOperation.IdPhotoNoExist\t库中无此号照片，请到户籍所在地进行核实。\nFailedOperation.IdPhotoPoorQuality\t证件图片分辨率太低，请重新上传。\nFailedOperation.IdPhotoSystemNoanswer\t客户库自建库或认证中心返照失败，请稍后再试。\nFailedOperation.LifePhotoDetectFaces\t检测到多张人脸。\nFailedOperation.LifePhotoDetectFake\t实人比对没通过。\nFailedOperation.LifePhotoDetectNoFaces\t未能检测到完整人脸。\nFailedOperation.LifePhotoPoorQuality\t传入图片分辨率太低，请重新上传。\nFailedOperation.LifePhotoSizeError\t传入图片过大或过小。\nFailedOperation.NameFormatError\t输入的姓名有误。\nFailedOperation.UnKnown\t内部未知错误。" }, "Description": { "type": "string", "description": "业务错误描述" }, "Sim": { "type": "string", "description": "相似度，取值范围 [0.00, 100.00]。推荐相似度大于等于70时可判断为同一人，可根据具体场景自行调整阈值（阈值70的误通过率为千分之一，阈值80的误通过率是万分之一）" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_7_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "IdCard": { "type": "string", "description": "身份证号" }, "Name": { "type": "string", "description": "姓名。中文请使用UTF-8编码。" }, "ImageBase64": { "type": "string", "minLength": 0, "maxLength": 10000000, "description": "用于人脸比对的照片，图片的BASE64值；\nBASE64编码后的图片数据大小不超过3M，仅支持jpg、png格式。" } }, "required": [ "ds_id", "IdCard", "Name", "ImageBase64" ] } } } } } }, "/2547-6": { "x-pointCode": 6, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "身份信息认证", "description": "传入姓名和身份证号，校验两者的真实性和一致性。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码。\n0: 姓名和身份证号一致\n-1: 姓名和身份证号不一致\n-2: 身份证号错误\n-3: 姓名错误\n-4: 认证出错" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_6_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "IdCard": { "type": "string", "description": "身份证号" }, "Name": { "type": "string", "description": "姓名" } }, "required": [ "ds_id", "IdCard", "Name" ] } } } } } }, "/2547-5": { "x-pointCode": 5, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "获取数字验证码", "description": "使用数字活体检测模式前，需调用本接口获取数字验证码。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "LiveCode": { "type": "string", "description": "数字验证码，如：1234" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_5_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2547-4": { "x-pointCode": 4, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "获取动作顺序", "description": "使用动作活体检测模式前，需调用本接口获取动作顺序。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "ActionSequence": { "type": "string", "description": "动作顺序(2,1 or 1,2) 。1代表张嘴，2代表闭眼。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_4_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" } }, "required": [ "ds_id" ] } } } } } }, "/2547-3": { "x-pointCode": 3, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "银行卡四要素核验", "description": "输入银行卡号、姓名、开户证件号、开户手机号，校验信息的真实性和一致性。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码。\n'0': '认证通过'\n'-1': '认证未通过'\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-5': '手机号码不合法'\n'-6': '持卡人信息有误'\n'-7': '未开通无卡支付'\n'-8': '此卡被没收'\n'-9': '无效卡号'\n'-10': '此卡无对应发卡行'\n'-11': '该卡未初始化或睡眠卡'\n'-12': '作弊卡、吞卡'\n'-13': '此卡已挂失'\n'-14': '该卡已过期'\n'-15': '受限制的卡'\n'-16': '密码错误次数超限'\n'-17': '发卡行不支持此交易'\n'-18': '服务繁忙'" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_3_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "Name": { "type": "string", "description": "姓名" }, "BankCard": { "type": "string", "description": "银行卡" }, "Phone": { "type": "string", "description": "手机号码" }, "IdCard": { "type": "string", "description": "身份证号码" }, "CertType": { "type": "number", "description": "证件类型，请确认该证件为开户时使用的证件类型，未用于开户的证件信息不支持验证。（默认0）\n0 身份证\n1 军官证\n2 护照\n3 港澳证\n4 台胞证\n5 警官证\n6 士兵证\n7 其它证件" } }, "required": [ "ds_id", "Name", "BankCard", "Phone", "IdCard", "CertType" ] } } } } } }, "/2547-2": { "x-pointCode": 2, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "银行卡三要素核验", "description": "输入银行卡号、姓名、开户证件号，校验信息的真实性和一致性。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "\t认证结果码。\n'0': '认证通过'\n'-1': '认证未通过'\n'-2': '姓名校验不通过'\n'-3': '身份证号码有误'\n'-4': '银行卡号码有误'\n'-5': '持卡人信息有误'\n'-6': '未开通无卡支付'\n'-7': '此卡被没收'\n'-8': '无效卡号'\n'-9': '此卡无对应发卡行'\n'-10': '该卡未初始化或睡眠卡'\n'-11': '作弊卡、吞卡'\n'-12': '此卡已挂失'\n'-13': '该卡已过期'\n'-14': '受限制的卡'\n'-15': '密码错误次数超限'\n'-16': '发卡行不支持此交易'\n'-17': '服务繁忙'" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_2_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "IdCard": { "type": "string", "description": "身份证号" }, "Name": { "type": "string", "description": "姓名" }, "BankCard": { "type": "string", "description": "银行卡" }, "CertType": { "type": "number", "description": "证件类型，请确认该证件为开户时使用的证件类型，未用于开户的证件信息不支持验证。（不填默认0）\n0 身份证\n1 军官证\n2 护照\n3 港澳证\n4 台胞证\n5 警官证\n6 士兵证\n7 其它证件" } }, "required": [ "ds_id", "IdCard", "Name", "BankCard", "CertType" ] } } } } } }, "/2547-1": { "x-pointCode": 1, "x-mode": "mapping", "x-read-timeout": 20, "x-connect-timeout": 20, "post": { "summary": "银行卡二要素核验", "description": "输入银行卡号、姓名，校验信息的真实性和一致性。", "responses": { "200": { "description": "成功响应", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ShowapiResEnvelope" }, { "type": "object", "properties": { "showapi_res_body": { "type": "object", "properties": { "Response": { "type": "object", "properties": { "Result": { "type": "string", "description": "认证结果码。\n'0': '认证通过'\n'-1': '认证未通过'\n'-2': '姓名校验不通过'\n'-3': '银行卡号码有误'\n'-4': '持卡人信息有误'\n'-5': '未开通无卡支付'\n'-6': '此卡被没收'\n'-7': '无效卡号'\n'-8': '此卡无对应发卡行'\n'-9': '该卡未初始化或睡眠卡'\n'-10': '作弊卡、吞卡'\n'-11': '此卡已挂失'\n'-12': '该卡已过期'\n'-13': '受限制的卡'\n'-14': '密码错误次数超限'\n'-15': '发卡行不支持此交易'\n'-16': '服务繁忙'" }, "Description": { "type": "string", "description": "认证结果信息。" }, "RequestId": { "type": "string", "description": "唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。" } } }, "remark": { "type": "string" }, "ret_code": { "type": "number" } }, "description": "业务返回体" } } } ] } } } } }, "operationId": "2547_1_POST", "parameters": [], "requestBody": { "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "ds_id": { "type": "string", "description": "数据源" }, "Name": { "type": "string", "description": "姓名" }, "BankCard": { "type": "string", "description": "银行卡" } }, "required": [ "ds_id", "Name", "BankCard" ] } } } } } } }, "components": { "securitySchemes": { "AppKeyAuth": { "type": "apiKey", "in": "query", "name": "appKey", "description": "从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp" } }, "schemas": { "ShowapiResEnvelope": { "type": "object", "description": "ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）", "properties": { "showapi_res_code": { "type": "integer", "description": "API 返回的状态码" }, "showapi_res_error": { "type": "string", "description": "API 返回的错误信息" }, "showapi_res_id": { "type": "string", "description": "API 请求的唯一标识" }, "showapi_fee_num": { "type": "integer", "description": "API 调用计费次数" } } } } }, "security": [ { "AppKeyAuth": [] } ], "externalDocs": { "url": "https://www.showapi.com/apiGateway/view/2547?tab=book" }, "x-apiCode": "2547", "x-is-own": false, "x-is-op": true }