查询实名认证信息(身份信息二要素)
<h3>接口功能:</h3>
<p>传入用户信息,查询实名认证结果和用户身份详细信息。</p>
<h3>请求URL:</h3>
<ul>
<li><code>api/kycloud/open/v1.0/auth/idcard/check</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>发送请求的时间,格式"yyyy-MM-dd HH:mm:ss"</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> "数据签名")</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>371726197103292594</td>
</tr>
<tr>
<td>userId</td>
<td>字符</td>
<td>否</td>
<td>20</td>
<td>用户ID,二选一</td>
<td>52984126340489216</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>code</td>
<td>字符</td>
<td>否</td>
<td>-</td>
<td>错误码</td>
<td>open_request_expired</td>
</tr>
<tr>
<td>success</td>
<td>字符</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>
<td>请求过期,请求重新发起</td>
</tr>
<tr>
<td>object</td>
<td>json</td>
<td>是</td>
<td>-</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>userId</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>用户ID</td>
<td>52984126340489216</td>
</tr>
<tr>
<td>name</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>姓名</td>
<td>张三</td>
</tr>
<tr>
<td>cardNumber</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>身份证号码</td>
<td>330102202301011122</td>
</tr>
<tr>
<td>address</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>户籍地址</td>
<td>北京市东城区故宫</td>
</tr>
<tr>
<td>age</td>
<td>字符</td>
<td>是</td>
<td>4</td>
<td>年龄</td>
<td>18</td>
</tr>
<tr>
<td>cardFrontUrl</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>身份证正面</td>
<td><a href="https://oss-cn-hangzhou.aliyuncs.com/123456.png"><a href="https://oss-cn-hangzhou.aliyuncs.com/123456.png">https://oss-cn-hangzhou.aliyuncs.com/123456.png</a></a></td>
</tr>
<tr>
<td>cardBackUrl</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>身份证反面</td>
<td><a href="https://oss-cn-hangzhou.aliyuncs.com/123456.png"><a href="https://oss-cn-hangzhou.aliyuncs.com/123456.png">https://oss-cn-hangzhou.aliyuncs.com/123456.png</a></a></td>
</tr>
<tr>
<td>startTime</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>证件开始时间</td>
<td>2000-01-01</td>
</tr>
<tr>
<td>entTime</td>
<td>字符</td>
<td>是</td>
<td>-</td>
<td>证件结束时间</td>
<td>2099-10-01</td>
</tr>
<tr>
<td>isAuth</td>
<td>布尔</td>
<td>是</td>
<td>-</td>
<td>是否实名</td>
<td>false:未实名,true:已实名</td>
</tr>
</tbody>
</table>
<h3>错误码</h3>
<table>
<thead>
<tr>
<th>错误码</th>
<th>错误描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>open_auth_user_not_existed_error</td>
<td>用户不存在</td>
</tr>
</tbody>
</table>
<h3>公共错误码</h3>
<p>参考:[公共错误码](<a href="https://www.showdoc.com.cn/kycloudopen/11199459988358587">https://www.showdoc.com.cn/kycloudopen/11199459988358587</a> "公共错误码")</p>