麒麟云服开放平台

麒麟云服开放平台接口


身份证二要素验证

<h3>接口功能</h3> <p>传入姓名和身份证号,校验两者的真实性和一致性。</p> <h3>请求URL</h3> <ul> <li><code>api/kycloud/open/v1.0/verify/idcard</code></li> </ul> <h3>请求方式</h3> <ul> <li>POST</li> </ul> <h3>公共请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>companyId</td> <td>数值</td> <td>是</td> <td>11</td> <td>平台分配给企业的ID</td> <td>52984126340489216</td> </tr> <tr> <td>charset</td> <td>字符</td> <td>是</td> <td>10</td> <td>请求使用的编码格式,如utf-8,gbk等</td> <td>utf-8</td> </tr> <tr> <td>signType</td> <td>字符</td> <td>是</td> <td>10</td> <td>企业生成签名字符串所使用的签名算法类型,目前支持RSA和RSA2,推荐使用RSA2</td> <td>RSA2</td> </tr> <tr> <td>bizContent</td> <td>json</td> <td>是</td> <td>不限</td> <td>请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递</td> <td>-</td> </tr> <tr> <td>timestamp</td> <td>字符</td> <td>是</td> <td>19</td> <td>发送请求的时间,格式&quot;yyyy-MM-dd HH:mm:ss&quot;</td> <td>2023-10-01 08:08:08</td> </tr> <tr> <td>sign</td> <td>字符</td> <td>是</td> <td>344</td> <td>企业请求参数的签名串,详见[数据签名](<a href="https://www.showdoc.com.cn/kycloudopen/11199716093743187">https://www.showdoc.com.cn/kycloudopen/11199716093743187</a> &quot;数据签名&quot;)</td> <td>详见示例</td> </tr> </tbody> </table> <h3>请求参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>最大长度</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>cardNumber</td> <td>字符</td> <td>是</td> <td>18</td> <td>用户身份证号</td> <td>330102202301011122</td> </tr> <tr> <td>name</td> <td>用户姓名</td> <td>是</td> <td>50</td> <td>用户姓名</td> <td>张三</td> </tr> </tbody> </table> <h3>公共响应参数</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>参数描述</th> <th>示例值</th> </tr> </thead> <tbody> <tr> <td>code</td> <td>字符</td> <td>否</td> <td>错误码</td> <td>open_request_expired</td> </tr> <tr> <td>success</td> <td>字符</td> <td>是</td> <td>请求是否成功,成功true、失败false</td> <td>true</td> </tr> <tr> <td>message</td> <td>字符</td> <td>是</td> <td>失败描述</td> <td>请求过期,请求重新发起</td> </tr> <tr> <td>object</td> <td>JSON</td> <td>否</td> <td>请求成功后,平台响应数据</td> <td>{“isVerify”: true}</td> </tr> </tbody> </table> <h3>响应数据</h3> <table> <thead> <tr> <th>参数名称</th> <th>类型</th> <th>是否必填</th> <th>参数描述</th> </tr> </thead> <tbody> <tr> <td>isVerify</td> <td>布尔</td> <td>是</td> <td>请求成功后,平台响应数据true 匹配成功false 匹配失败</td> </tr> </tbody> </table> <h3>公共错误码</h3> <p>参考:[公共错误码](<a href="https://www.showdoc.com.cn/kycloudopen/11199459988358587">https://www.showdoc.com.cn/kycloudopen/11199459988358587</a> &quot;公共错误码&quot;)</p>

页面列表

ITEM_HTML