> ## 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/06efe2aa-5443-4dcc-af2f-28236bfb2158) の該当ページでサービスを申請する必要があります。ページに入ったら、「Acquire」ボタンをクリックします。以下の図のように：

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

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

初回申請時には無料の利用枠が付与され、このAPIを無料で使用できます。

## 基本使用

まず、基本的な使用方法を理解します。銀行カードのカード番号情報を入力することで、処理後の結果画像を取得できます。まず、`bank_card` フィールドを簡単に渡す必要があります。次に、インターフェースに対応する内容を入力します。以下の図のように：

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

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

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

また、Request Bodyを設定しました。これには以下が含まれます：

* `bank_card`：処理する銀行カード番号情報。必須パラメータです。
* `name`：ユーザーの名前。必須パラメータです。
* `encryption`：オプション、機密フィールドの暗号化パラメータ（暗号文を送信する必要がある場合）。

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

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

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

```json theme={null}
{
  "result": "0",
  "description": "認証通過"
}
```

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

* `result`、認証結果コード、料金状況は以下の通りです。
  * 料金結果コード：
    * 0: 認証通過
    * -1: 認証未通過
    * -4: 持ち主情報に誤り
    * -5: 無カード決済が未開通
    * -6: このカードは押収されました
    * -7: 無効なカード番号
    * -8: このカードには対応する発行銀行がありません
    * -9: このカードは未初期化またはスリープカードです
    * -10: 不正カード、飲み込みカード
    * -11: このカードは紛失届が出されています
    * -12: このカードは期限切れです
    * -13: 制限されたカード
    * -14: パスワードエラー回数超過
    * -15: 発行銀行がこの取引をサポートしていません
  * 無料結果コード：
    * -2: 名前確認未通過
    * -3: 銀行カード番号に誤り
    * -16: 検証センターサービスが混雑しています
    * -17: 検証回数超過、翌日再試行してください
* `description`、業務結果の説明。

この銀行カードの名前と銀行カード番号の真実性と一貫性が確認されたことがわかります。

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

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

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

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

## エラー処理

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の接続と使用をより良くする手助けとなることを願っています。何か問題があれば、いつでも技術サポートチームにお問い合わせください。
