> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# 身份证识别及信息核验 API 对接说明

> Identity Authentication 集成指南 - XHuoAPI

本文将介绍一种 身份证识别及信息核验 API 对接说明，它可以通过输入身份证图片 或 姓名和身份证号码，来校验姓名和身份证号的真实性和一致性。本接口用于校验姓名和身份证号的真实性和一致性，您可以通过输入姓名和身份证号或传入身份证人像面照片提供所需验证信息。

## 申请流程

要使用 API，需要先到 [身份证识别及信息核验 API](https://api.xhuoapi.ai/documents/67f96afa-60b8-4cbb-a4bf-0cbfcf139a23) 对应页面申请对应的服务，进入页面之后，点击「Acquire」按钮，如图所示：

![](https://cdn.xhuoapi.ai/q6ytrc.png)

如果你尚未登录或注册，会自动跳转到登录页面邀请您来注册和登录，登录注册之后会自动返回当前页面。

在首次申请时会有免费额度赠送，可以免费使用该 API。

## 基本使用

首先先了解下基本的使用方式，就是输入身份证图片链接，便可获得处理后验证结果，首先需要简单地传递一个 `image_url` 字段，我们接下来就可以在界面上填写对应的内容，如图所示：

<p>
  <img src="https://cdn.xhuoapi.ai/qxy9rh.png" width="500" className="m-auto" />
</p>

可以看到这里我们设置了 Request Headers，包括：

* `accept`：想要接收怎样格式的响应结果，这里填写为 `application/json`，即 JSON 格式。
* `authorization`：调用 API 的密钥，申请之后可以直接下拉选择。

另外设置了 Request Body，包括：

* `image_url`：需要处理的身份证图片链接。
* `encryption`：可选，敏感字段加密参数（如需上送密文）。

选择之后，可以发现右侧也生成了对应代码，如图所示：

<p>
  <img src="https://cdn.xhuoapi.ai/uw90il.png" width="500" className="m-auto" />
</p>

点击「Try」按钮即可进行测试，如上图所示，这里我们就得到了如下结果：

```json theme={null}
{
  "result": "0",
  "description": "姓名和身份证号一致",
  "name": "身份证姓名",
  "id_card": "身份证号码",
  "sex": "身份证性别",
  "nation": "身份证民族",
  "birth": "身份证生日",
  "address": "身份证家庭住址"
}
```

返回结果一共有多个字段，介绍如下：

* `result `，认证结果码，收费情况如下。
  * 收费结果码：
    * 0: 姓名和身份证号一致
    * -1: 姓名和身份证号不一致
  * 不收费结果码：
    * -2: 非法身份证号（长度、校验位等不正确）
    * -3: 非法姓名（长度、格式等不正确）
    * -4: 证件库服务异常
    * -5: 证件库中无此身份证记录
    * -6: 权威比对系统升级中，请稍后再试
    * -7: 认证次数超过当日限制。
* `description`，此处姓名与身份证号码验证的结果。
* `name`，身份证中的姓名信息，如果没有上传身份证图片则是空的。
* `id_card`，身份证中的身份证号码信息，如果没有上传身份证图片则是空的。
* `sex`，身份证中的性别信息，如果没有上传身份证图片则是空的。
* `nation`，身份证中的民族信息，如果没有上传身份证图片则是空的。
* `birth`，身份证中的生日信息，如果没有上传身份证图片则是空的。
* `address`，身份证中的家庭住址信息，如果没有上传身份证图片则是空的。

可以看出身份证中姓名与身份证号码的信息是一致性并且有效的，同时也使用OCR技术提取了其它的信息并展示出来。

另外如果想生成对应的对接代码，可以直接复制生成，例如 CURL 的代码如下：

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/ocr' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "image_url": {image_url}
}'
```

Python 的对接代码如下：

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/idcard/ocr"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "image_url": {image_url}
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

## 自定义信息验证

我们也提供了一种不泄露身份证图片信息的方式来验证，可以只传入姓名`name` 和 身份证号码 `id_card` 来进行校验姓名和身份证号的真实性和一致性，下面是填的具体信息：

<p>
  <img src="https://cdn.xhuoapi.ai/mc5bbw.png" width="500" className="m-auto" />
</p>

点击运行后得到如下结果：

```json theme={null}
{
    "address": "",
    "birth": "",
    "description": "姓名和身份证号一致",
    "id_card": "身份证号码",
    "name": "身份证姓名",
    "nation": "",
    "result": "0",
    "sex": ""
 }
```

这样从结果看就不会泄露其它隐私信息了，这也可以完成校验姓名和身份证号的真实性和一致性。

## 错误处理

在调用 API 时，如果遇到错误，API 会返回相应的错误代码和信息。例如：

* `400 token_mismatched`：Bad request, possibly due to missing or invalid parameters.
* `400 api_not_implemented`：Bad request, possibly due to missing or invalid parameters.
* `401 invalid_token`：Unauthorized, invalid or missing authorization token.
* `429 too_many_requests`：Too many requests, you have exceeded the rate limit.
* `500 api_error`：Internal server error, something went wrong on the server.

### 错误响应示例

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## 结论

通过本文档，您已经了解了如何使用 身份证识别及信息核验 API 对输入的图片 或 姓名与身份证号码信息来进行校验姓名和身份证号的真实性和一致性。希望本文档能帮助您更好地对接和使用该 API。如有任何问题，请随时联系我们的技术支持团队。