> ## 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」ボタンをクリックします。以下の図のように：
まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。
初回申請時には無料の枠が提供され、この API を無料で使用できます。
## 基本使用
まず、基本的な使用方法を理解します。身分証の画像リンクを入力するだけで、処理後の検証結果を得ることができます。まず、`image_url` フィールドを簡単に渡す必要があります。次に、画面上に対応する内容を記入できます。以下の図のように：
ここでは、Request Headers を設定しています。これには以下が含まれます：
* `accept`：受け取りたいレスポンス結果の形式。ここでは `application/json`、つまり JSON 形式を記入します。
* `authorization`：API を呼び出すためのキー。申請後、直接ドロップダウンから選択できます。
また、Request Body を設定しています。これには以下が含まれます：
* `image_url`：処理する身分証の画像リンク。
* `encryption`：オプション、機密フィールドの暗号化パラメータ（暗号文を送信する必要がある場合）。
選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように：
「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` を入力するだけで、姓名と身分証番号の真実性と一致性を検証できます。以下は具体的な情報を入力したものです：
実行をクリックすると、以下の結果が得られます：
```json theme={null}
{
"address": "",
"birth": "",
"description": "姓名と身分証番号は一致しています",
"id_card": "身分証番号",
"name": "身分証姓名",
"nation": "",
"result": "0",
"sex": ""
}
```
このように、結果からは他のプライバシー情報が漏れないことがわかります。これにより、姓名と身分証番号の真実性と一致性を検証することができます。
## エラー処理
API を呼び出す際にエラーが発生した場合、API は対応するエラーコードと情報を返します。例えば：
* `400 token_mismatched`：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
* `400 api_not_implemented`：不正なリクエスト、パラメータが不足しているか無効である可能性があります。
* `401 invalid_token`：未承認、無効または不足している承認トークン。
* `429 too_many_requests`：リクエストが多すぎます、レート制限を超えました。
* `500 api_error`：内部サーバーエラー、サーバーで何かがうまくいきませんでした。
### エラー応答の例
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## 結論
この文書を通じて、身分証識別及び情報検証 API を使用して、入力された画像または名前と身分証番号情報を基に、姓名と身分証番号の真実性と一致性を検証する方法を理解しました。この文書が、API の接続と使用をより良くする手助けとなることを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。