> 作者：xuxl
> 时间：2021.10.12

<a name="v4GhB"></a>
# 通用响应
code为**000000**即代表成功, 其他情况则为失败。
<a name="LIpsN"></a>
# 接口列表

---

<a name="DxKkG"></a>
## 获取授权Token（Auth Token）
> 说明：auth_token有效期为**30分钟，每个用户需单独获取，不能共用**

<a name="hKufk"></a>
#### 请求URL：
https://apisdk.253.com/plat_app/platform/app/token/get
<a name="wXM5E"></a>
#### 请求方式：POST
<a name="EOa6n"></a>
#### 请求Header：
| 参数 | 值 |
| --- | --- |
| Content-Type | application/json |

<a name="Jx6g1"></a>
#### 请求参数：
| 参数 | 是否必须 | 类型 | 说明 |
| --- | --- | --- | --- |
| appKey | 是 | String | 创蓝appKey |
| appSecret | 是 | String | 创蓝appSecret |
| did | 是 | String | 客户自己生成随机码 **长度**【0~32】 |

<a name="YET2s"></a>
#### 请求示例：
```json
{
	"appKey": "X6IfC4BO",
	"appSecret": "397T7Nn9",
	"did": "1375369787324108800"
}
```
<a name="SCxWX"></a>
#### 返回参数：
| 参数 | 是否必须 | 类型 | 说明 |
| --- | --- | --- | --- |
| authToken | 是 | String | 认证令牌 **温馨提示：每个用户需单独获取，不能共用** |

<a name="GydM5"></a>
#### 返回示例：
```json
{
 "code": "000000",
 "message": "成功",
 "data": {
 "authToken": "1CFD08D67E724845A54F5AE2C83D0A6A"
 }
}
```

---

<a name="saBSC"></a>
## 活体检测
<a name="A3VPJ"></a>
### 人像比对（核身）
<a name="TLsKH"></a>
#### 请求URL：
https://sdk.253.com/identity_auth/faceAlive/v3/match
<a name="h2nns"></a>
#### 请求方式：POST
<a name="EEEDO"></a>
#### 请求Header：
| 参数 | 值 |
| --- | --- |
| Content-Type | application/json |

<a name="VWs6Q"></a>
#### 请求参数：
| 参数 | 是否必须 | 类型 | 说明 |
| --- | --- | --- | --- |
| app_key | 是 | String | 创蓝appKey |
| auth_token | 是 | String | 认证令牌 [auth_token获取接口](#L4cmP) |
| id_card_no | 是 | String | 身份证号 需经过RSA加密，请用公钥加密，**公钥请向上海创蓝云智信息科技股份有限公司运营人员申请** [**加密代码示例**](https://sdk.253.com/document-detail/uwh7bh/pg9mi9#toc3) |
| id_card_name | 是 | String | 身份证姓名 需经过RSA加密，请用公钥加密，**公钥请向上海创蓝云智信息科技股份有限公司运营人员申请** [**加密代码示例**](https://sdk.253.com/document-detail/uwh7bh/pg9mi9#toc3) |

<a name="sBYyu"></a>
#### 请求示例：
```json
{
	"app_key": "wyeTncRs38GMDm5b",
	"auth_token": "lxllksdfikjkjsf3fdsflxldnm",
	"id_card_no": "420528199206241438",
	"id_card_name": "张三丰"
}
```
<a name="ptr0A"></a>
#### 返回参数：
| 参数 | 是否必须 | 类型 | 说明 |
| --- | --- | --- | --- |
| match | 是 | String | 比对结果 pass:通过 fail:不通过 |
| score | 是 | String | 人像分值 范围[0,100] |
| desc | 否 | String | 比对结果描述 |
| image | 否 | String | base64编码后的人像图片信息。需要注意的是，**该值仅在人像对比成功后返回**。 |

<a name="eXlJn"></a>
#### 返回示例：
```json
{
	"code": "000000",
	"message": "成功",
	"data": {
		"match": "pass",
		"score": "98",
		"desc": "比对成功",
		"image": "/9j/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAPABDgDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQ"
	}
}
```

---

<!doctype html><div class="lake-content" typography="classic"><div class="ne-quote">作者：xuxl时间：2021.10.12</div><h1 id="v4GhB">通用响应</h1>code为000000即代表成功, 其他情况则为失败。<h1 id="LIpsN">接口列表</h1><hr id="hrcci" class="ne-hr"><h2 id="DxKkG">获取授权Token（Auth Token）</h2><div class="ne-quote">说明：auth_token有效期为30分钟，每个用户需单独获取，不能共用</div><h4 id="hKufk">请求URL：</h4>https://apisdk.253.com/plat_app/platform/app/token/get<h4 id="wXM5E">请求方式：POST</h4><h4 id="EOa6n">请求Header：</h4><table id="NTq2G" class="ne-table" style="width: 500px"><tbody><tr style="height: 33px"><td width="250">参数</td><td width="250">值</td></tr><tr style="height: 33px"><td width="250">Content-Type</td><td width="250">application/json</td></tr></tbody></table><h4 id="Jx6g1">请求参数：</h4><table id="tD1QI" class="ne-table" style="width: 750px"><tbody><tr style="height: 33px"><td width="188">参数</td><td width="188">是否必须</td><td width="188">类型</td><td width="186">说明</td></tr><tr style="height: 36px"><td width="188">appKey</td><td width="188">是</td><td width="188">String</td><td width="186">创蓝appKey</td></tr><tr style="height: 33px"><td width="188">appSecret</td><td width="188">是</td><td width="188">String</td><td width="186">创蓝appSecret</td></tr><tr style="height: 33px"><td width="188">did</td><td width="188">是</td><td width="188">String</td><td width="186">客户自己生成随机码长度【0~32】</td></tr></tbody></table><h4 id="YET2s">请求示例：</h4><pre data-language="json" id="xiStw" class="ne-codeblock language-json">{
	&quot;appKey&quot;: &quot;X6IfC4BO&quot;,
	&quot;appSecret&quot;: &quot;397T7Nn9&quot;,
	&quot;did&quot;: &quot;1375369787324108800&quot;
}</pre><h4 id="SCxWX">返回参数：</h4><table id="P02rd" class="ne-table" style="width: 749px"><tbody><tr style="height: 33px"><td width="189">参数</td><td width="130">是否必须</td><td width="104">类型</td><td width="326">说明</td></tr><tr style="height: 40px"><td width="189">authToken</td><td width="130">是</td><td width="104">String</td><td width="326">认证令牌 温馨提示：每个用户需单独获取，不能共用</td></tr></tbody></table><h4 id="GydM5">返回示例：</h4><pre data-language="json" id="G7zfY" class="ne-codeblock language-json">{
 &quot;code&quot;: &quot;000000&quot;,
 &quot;message&quot;: &quot;成功&quot;,
 &quot;data&quot;: {
 &quot;authToken&quot;: &quot;1CFD08D67E724845A54F5AE2C83D0A6A&quot;
 }
}</pre><hr id="k1yQK" class="ne-hr"><h2 id="saBSC">活体检测</h2><h3 id="A3VPJ">人像比对（核身）</h3><h4 id="TLsKH">请求URL：</h4>https://sdk.253.com/identity_auth/faceAlive/v3/match<h4 id="h2nns">请求方式：POST</h4><h4 id="EEEDO">请求Header：</h4><table id="EhAbW" class="ne-table" style="width: 500px"><tbody><tr style="height: 33px"><td width="250">参数</td><td width="250">值</td></tr><tr style="height: 33px"><td width="250">Content-Type</td><td width="250">application/json</td></tr></tbody></table><h4 id="VWs6Q">请求参数：</h4><table id="lzVpG" class="ne-table" style="width: 750px"><tbody><tr style="height: 33px"><td width="188">参数</td><td width="188">是否必须</td><td width="188">类型</td><td width="186">说明</td></tr><tr style="height: 36px"><td width="188">app_key</td><td width="188">是</td><td width="188">String</td><td width="186">创蓝appKey</td></tr><tr style="height: 33px"><td width="188">auth_token</td><td width="188">是</td><td width="188">String</td><td width="186">认证令牌<a href="#L4cmP" data-href="#L4cmP" target="_blank" class="ne-link">auth_token获取接口</a></td></tr><tr style="height: 33px"><td width="188">id_card_no</td><td width="188">是</td><td width="188">String</td><td width="186">身份证号需经过RSA加密，请用公钥加密，公钥请向上海创蓝云智信息科技股份有限公司运营人员申请<a href="https://sdk.253.com/document-detail/uwh7bh/pg9mi9#toc3" data-href="https://sdk.253.com/document-detail/uwh7bh/pg9mi9#toc3" target="_blank" class="ne-link">加密代码示例</a></td></tr><tr style="height: 33px"><td width="188">id_card_name</td><td width="188">是</td><td width="188">String</td><td width="186">身份证姓名需经过RSA加密，请用公钥加密，公钥请向上海创蓝云智信息科技股份有限公司运营人员申请<a href="https://sdk.253.com/document-detail/uwh7bh/pg9mi9#toc3" data-href="https://sdk.253.com/document-detail/uwh7bh/pg9mi9#toc3" target="_blank" class="ne-link">加密代码示例</a></td></tr></tbody></table><h4 id="sBYyu">请求示例：</h4><pre data-language="json" id="ErUOI" class="ne-codeblock language-json">{
	&quot;app_key&quot;: &quot;wyeTncRs38GMDm5b&quot;,
	&quot;auth_token&quot;: &quot;lxllksdfikjkjsf3fdsflxldnm&quot;,
	&quot;id_card_no&quot;: &quot;420528199206241438&quot;,
	&quot;id_card_name&quot;: &quot;张三丰&quot;
}</pre><h4 id="ptr0A">返回参数：</h4><table id="JqETk" class="ne-table" style="width: 749px"><tbody><tr style="height: 33px"><td width="189">参数</td><td width="130">是否必须</td><td width="104">类型</td><td width="326">说明</td></tr><tr style="height: 40px"><td width="189">match</td><td width="130">是</td><td width="104">String</td><td width="326">比对结果pass:通过fail:不通过</td></tr><tr style="height: 40px"><td width="189">score</td><td width="130">是</td><td width="104">String</td><td width="326">人像分值 范围[0,100]</td></tr><tr style="height: 40px"><td width="189">desc</td><td width="130">否</td><td width="104">String</td><td width="326">比对结果描述</td></tr><tr style="height: 40px"><td width="189">image</td><td width="130">否</td><td width="104">String</td><td width="326">base64编码后的人像图片信息。需要注意的是，该值仅在人像对比成功后返回。</td></tr></tbody></table><h4 id="eXlJn">返回示例：</h4><pre data-language="json" id="VqeLC" class="ne-codeblock language-json">{
	&quot;code&quot;: &quot;000000&quot;,
	&quot;message&quot;: &quot;成功&quot;,
	&quot;data&quot;: {
		&quot;match&quot;: &quot;pass&quot;,
		&quot;score&quot;: &quot;98&quot;,
		&quot;desc&quot;: &quot;比对成功&quot;,
		&quot;image&quot;: &quot;/9j/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAPABDgDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQ&quot;
	}
}</pre><hr id="ZThS7" class="ne-hr"></div>

App及web服务端API文档

使用入门

功能介绍

开发文档

常见问题

羊毛盾标准版

客户端接入

服务端接入

图文验证码

认证安全

创蓝云智，为企业提供全面的数据接口API/SDK。免费试用，满意为止。致力于让企业更高效高质量的获得用户及触达用户。

注册登录

新客获客

老客激活

金融行业

游戏行业

电商行业

餐饮行业

App及web服务端API文档