> ## 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/667017a4-017f-4af0-870e-807034f70632) の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：

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

まだログインまたは登録していない場合は、自動的にログインページにリダイレクトされ、登録とログインを促されます。ログインまたは登録後、現在のページに自動的に戻ります。

初回申請時には無料のクレジットが付与され、この API を無料で使用できます。

## 基本使用

まず、基本的な使用方法を理解します。身分証明書の画像リンクを入力することで、処理後の検証結果を得ることができます。最初に `name` フィールドを簡単に渡す必要があります。次に、画面上に対応する内容を入力できます。以下の図のように：

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

ここでは、Request Headers を設定しています。これには以下が含まれます：

* `accept`：受け取りたいレスポンス結果の形式。ここでは `application/json`、つまり JSON 形式を記入します。
* `authorization`：API を呼び出すためのキー。申請後、直接ドロップダウンから選択できます。

さらに、Request Body を設定しています。これには以下が含まれます：

* `name`：名前。
* `id_card`：身分証明書番号。
* `image_url`：処理する顔画像のリンク。
* `validity_end`：身分証明書の有効期限の終了日、形式：YYYYMMDD、長期の場合は「00000000」で代用；
* `validity_begin`：身分証明書の有効期限の開始日、形式：YYYYMMDD。
* `encryption`：オプション、機密フィールドの暗号化パラメータ（暗号文を送信する必要がある場合）。

選択後、右側にも対応するコードが生成されていることがわかります。以下の図のように：

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

「Try」ボタンをクリックするとテストが行えます。上の図のように、以下の結果が得られました：

```json theme={null}
{
  "result": "0",
  "description": "一致"
}
```

返された結果には複数のフィールドがあり、以下のように説明されます：

* `result`、認証結果コード、料金の状況は以下の通りです。
  * 有料結果コード：
    * 0: 名前と身分証明書番号が一致
    * -1: 名前と身分証明書番号が不一致
  * 無料結果コード：
    * -2: 不正な身分証明書番号（長さ、チェックディジットなどが不正）
    * -3: 不正な名前（長さ、形式などが不正）
    * -4: 証明書データベースサービスの異常
    * -5: 証明書データベースにこの身分証明書の記録がない
    * -6: 権威ある照合システムのアップグレード中、後で再試行してください
    * -7: 認証回数が当日の制限を超えました。
* `description`、ここでは名前と身分証明書番号の検証結果です。

身分証明書の中の名前、身分証明書番号、身分証明書の有効期限が真実性と一貫性を持っていることがわかります。

また、対応する接続コードを生成したい場合は、生成されたものを直接コピーできます。例えば、CURL のコードは以下の通りです：

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "name": "***",
  "id_card": "***",
  "validity_begin": "***",
  "validity_end": "***"
}'
```

Python の接続コードは以下の通りです：

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/identity/idcard/check-2e"

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

payload = {
    "name": "***",
    "id_card": "***",
    "validity_begin": "***",
    "validity_end": "***"
}

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

## エラー処理

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 の接続と使用をより良くする手助けとなることを願っています。ご不明な点がございましたら、いつでも技術サポートチームにお問い合わせください。