身份证四要素

API: Factor/idcard4

概览

Factor/idcard4是submail的身份证四要素认证API,验证姓名、身份证号、身份证有效期是否一致。


URL

<主> http://tpa.mysubmail.com/factor/idcard4  
<备> https://tpa.mysubmail.com/factor/idcard4

http请求方式

请求方式content-type设置
http postmultipart/form-data、x-www-form-urlencoded、application/json

返回参数格式

jsonString


请求参数说明

参数是否必填类型类型
appidstring在 SUBMAIL 身份认证服务中创建并且认证通过的应用 ID
timestampstringUNIX 时间戳
signaturestring签名,详细规则看下方介绍
idNostring身份证号码
namestring用户姓名
begin_datestring身份证有效时间-开始时间 格式:20210101
end_datestring身份证有效时间-结束时间 格式:20210101 长期有效填写 L

signature创建规则

  1. 请将以下参数按照字段升序(A-Z)排列 appkey 、idNo 、name 、timestamp
  2. 创建签名字符串 :以"key=value" + "&"(连接符)+ "key=value" 的方式连接所有参数
  3. 创建签名:拼接签名字符串示例string = "appkey=xxxx&idNo=xxxx&name=xxxx×tamp=xxxxxxxxxx",然后使用sha256(string)创建签名
    注:中文需要使用urlencode处理后再参与创建签名

响应消息

API请求失败
{
    'status'  : 'error' ,                                          // 状态描述
    'send_id' : 'ee05d1635db847a2bf3c8317434539d6',                // API流水号
    'code'    : 1201 ,                                             // API返回的状态码    详情查看 API错误代码与描述  文档
    'msg'     : 'Incorrect APP ID.' ,                              // API返回的描述、  
}
API请求成功
{
    'status'  : 'success' ,                                       // 状态描述
    'send_id' : 'ee05d1635db847a2bf3c8317434539d6',               // API流水号
    'result' : {
        'bank_msg'     => '核查一致',                               //结果描述
        'status'       => '01',                                   //结果状态码   01:核查一致  02:不一致
        'bank_idCard'  => '*****************',                    //身份证号码
        'bank_name'    => '***',                                  //用户名字
        'begin_date'   => '***',                                  //身份证有效时间-开始时间 
        'end_date'     => '***',                                  //身份证有效时间-结束时间
    };
}