接入文档
数据智能产品体系
Special List-IDN
Special List-IDN
# 一、接口描述
通过三要素入参，返回特殊名单命中情况等
# 二、接口地址
https://api-idn.yljz.com/finauth/v3/rc/speciallist_idn
# 三、调用方法
POST（需使用form-data格式请求）
# 四、请求参数
| 可选/必选 | 参数英文名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | sign | String | 签名生成规则参考鉴权说明 |
| 必选 | sign_version | String | 签名算法版本号，目前仅支持:"hmac_sha1" |
| 必选 | id_number |
String | 身份证号（md5/sha256/sm3） 【注意：如有字母需大写】 |
| 必选 | phone |
String | 手机号（md5/sha256/sm3） 【注意：不需要加国家码】 |
| 必选（二选一） |
face_image_file | File | 人脸图片（不能超过2M） |
| face_image_base64 | String | 人脸图片Base64 | |
| 可选 |
hash_type |
String | 身份证及手机号的哈希方式： md5(默认) sha256 sm3 |
# 五、产品出参
| 参数英文名 | 参数中文名 | 类型 | 参数说明 |
|---|---|---|---|
| face_attack_flag | 是否命中人脸黑名单 |
Int | 0：未命中 1：命中 |
| face_attack_result |
人脸黑名单详情 |
Json |
返回人脸黑名单相关佐证信息： • "media_2d_flag"：Int类型，二维介质仿生特征，0=未命中；1=命中 • "display_replay_flag"：Int类型，显示链路重放异常，0=未命中；1=命中 • "cutout_flag"：Int类型，物理裁剪仿生特征，0=未命中；1=命中 • "mask_2d_flag"：Int类型，物理面具仿生特征，0=未命中；1=命中 • "mask_3d_flag"：Int类型，三维仿生介质特征，0=未命中；1=命中 • "face_cover_flag"：Int类型，面部覆盖状态异常，0=未命中；1=命中 • "digital_edit_flag"：Int类型，数字合成异常特征，0=未命中；1=命中 • "eye_state_flag"：Int类型，眼部状态异常，0=未命中；1=命中 • "identity_shift_flag"：Int类型，动态身份一致性异常，0=未命中；1=命中 • "scene_risk_flag"：Int类型，环境风险上下文，0=未匹配；1=匹配 • "other_risk_flag"：Int类型，残余风险标记，0=未命中；1=命中 |
| related_device_flag |
是否命中设备黑名单 |
Int | 0：未命中 1：命中 |
| related_face_attack_flag | 关联网络是否命中人脸黑名单 |
Int | 0：未命中 1：命中 |
# 六、HTTP状态码
| http状态码 | 错误信息 | 意义说明 |
|---|---|---|
| 200 | 正常值，服务器成功返回用户请求的数据 | |
| 400 | INVALID_IMAGE | image超出2M |
| 400 | IMAGE_ERROR_UNSUPPORTED_FORMAT | 上传的图像无法解析 |
| 400 | NO_FACE_FOUND | 图片中未找到人脸 |
| 400 | FACE_NOT_FOUND | 人脸未关联到对应数据 |
| 400 | BAD_ARGUMENTS:<key> | 某个参数解析出错(比如必须是数字，但是输入的是非数字字符串，或者长度过长) |
| 400 | MISSING_ARGUMENTS:<key> | 缺少某个必选参数 |
| 403 | AUTHENTICATION_ERROR | 无效签名 |
| 403 | AUTHENTICATION_ERROR:<reason> | api_key被停用、调用次数超限、没有调用此API的权限，或者没有以当前方式调用此API的权限 <reason>取值: - API_KEY_BE_DISCONTINUED:api_key被停用 - IP_NOT_ALLOWED:不允许访问的IP - LIMIT_REACHED:测试api_key调用量已达到上限 - DENIED:无权限调用当前API - EXPIRED_SIGN:签名已过期 - INVALID_SIGN:无效签名 其他可能的错误码 |
| 403 | CONCURRENCY_LIMIT_EXCEEDED | 并发数超过限制 |
| 404 | API_NOT_FOUND | 所调用的API不存在 |
| 500 | INTERNAL_ERROR | 如果持续出现此类错误，请及时联系客服或商务 |