β提供中 Resolve API

銀行・支店名の全件目視確認を、確認が必要な入力に絞り込む。

CSV・OCR・取引先マスタなどの入力から銀行コード・支店コード候補を返し、自動処理に進めるか、人が確認すべきかの判断材料を提供します。

Endpoint
POST https://apis.bankcode-jp.com/resolve/v1/bank-branch

Freeプランを含むすべての登録ユーザーが、既存のAPIキーで利用できます。正式版の提供開始までは追加料金はかかりません。

Search APIとの違い

検索候補を返すAPIと、入力の扱いを判断するAPIです。

Search APIとResolve APIは用途が異なるAPIです。Search APIは金融機関名・支店名・コードから検索候補を返し、Resolve APIは表記揺れや曖昧さを含む入力から候補を推定します。

API主な用途
Search API金融機関名・支店名・コードから検索候補を返す
Resolve API表記揺れや曖昧さを含む入力から候補を推定し、decisionと理由によって後続処理の判断を支援する
Use cases

3つの利用例

CSV取込

外部から受領した銀行・支店情報を候補化し、確認が必要な行を抽出する

OCR結果の照合

OCRで読み取った名称の表記揺れを吸収し、候補と判定理由を確認する

取引先マスタ整備

既存マスタの銀行・支店情報について、確認対象を絞り込む

Playground

実API Playground

銀行名・支店名を入力して、Resolve APIの判定結果をその場で確認できます。
この画面ではデモ用のAPIキーで実際のレスポンスを確認できます。APIキー入力は不要です。

この画面はデモ用APIキーで動作します。
本番サービスで利用するAPIキーは、必要に応じてサーバー側で管理してください。

POST /resolve/v1/bank-branch
needs_review 候補はありますが確認が必要です
{
  "decision": "needs_review",
  "best_match": {
    "bank_code": "0038",
    "bank_name": "住信SBIネット銀行",
    "branch_code": "208",
    "branch_name": "USEN支店"
  },
  "candidates": [
    {
      "bank_code": "0038",
      "bank_name": "住信SBIネット銀行",
      "branch_code": "208",
      "branch_name": "USEN支店"
    },
    {
      "bank_code": "0038",
      "bank_name": "住信SBIネット銀行",
      "branch_code": "302",
      "branch_name": "USEN法人支店"
    }
  ],
  "reason_codes": [
    "branch_alias_ambiguous",
    "gap_too_small"
  ],
  "reason_details": [
    {
      "code": "branch_alias_ambiguous",
      "message_ja": "支店名の略称が同一銀行内の複数支店に該当する可能性があります"
    }
  ],
  "reason_summary_ja": "支店名の略称が同一銀行内の複数支店に該当する可能性があります"
}
Decision

decisionを基準に、自動処理候補と確認・補正へ分岐します。

decisionは状態遷移ではなく、1回のResolve結果として排他的に返る値です。まずdecisionを基準に分岐し、理由フィールドは説明や確認画面の補助に使います。

自動処理候補

auto_confirm

十分な確度で候補を特定でき、自動処理候補として扱えます。

確認・補正

needs_review

有力候補はあるが、人による確認を推奨する

ambiguous

候補は存在するが、一意に判断できない、または確度が不足している

unresolved

候補を特定できない。candidates は空配列で、best_match は返りません

Reason fields

理由フィールドは、判定の説明と確認画面の補助に使えます。

後続処理の分岐は、まず decision を基準にしてください。reason_codes は機械処理に利用できる理由コードの配列、 reason_details は各理由の詳細情報、reason_summary_ja は代表的な理由の日本語要約です。

reason codeの完全な一覧はAPIドキュメントをご確認ください。

branch_alias_ambiguous

支店名略称が同一銀行内の複数支店に該当する可能性がある

gap_too_small

上位候補と次点候補の差が小さい

payment_branch_trim

payment用途で支店名の接尾辞除去を含む

payment_branch_supplement

payment用途で支店名補完を含む

curl / Response

リクエストとレスポンスを確認する

以下のcurl例でResolve APIを呼び出し、判定結果のレスポンス形式を確認できます。

curl

curl -s -X POST "https://apis.bankcode-jp.com/resolve/v1/bank-branch" \
  -H "Content-Type: application/json; charset=utf-8" \
  -H "X-API-KEY: ${BANKCODEJP_API_KEY}" \
  -d '{"bank_name":"住信SBIネット銀行","branch_name":"USEN","context":"default"}' | jq

needs_review レスポンス例

{
  "decision": "needs_review",
  "best_match": {
    "bank_code": "0038",
    "bank_name": "住信SBIネット銀行",
    "branch_code": "208",
    "branch_name": "USEN支店"
  },
  "candidates": [
    {
      "bank_code": "0038",
      "bank_name": "住信SBIネット銀行",
      "branch_code": "208",
      "branch_name": "USEN支店"
    },
    {
      "bank_code": "0038",
      "bank_name": "住信SBIネット銀行",
      "branch_code": "302",
      "branch_name": "USEN法人支店"
    }
  ],
  "reason_codes": [
    "branch_alias_ambiguous",
    "gap_too_small"
  ],
  "reason_details": [
    {
      "code": "branch_alias_ambiguous",
      "message_ja": "支店名の略称が同一銀行内の複数支店に該当する可能性があります"
    }
  ],
  "reason_summary_ja": "支店名の略称が同一銀行内の複数支店に該当する可能性があります"
}

unresolved レスポンス例

{
  "decision": "unresolved",
  "candidates": [],
  "reason_codes": [
    "bank_not_found"
  ],
  "reason_details": [
    {
      "code": "bank_not_found",
      "message_ja": "入力された銀行名に一致する金融機関候補を特定できません"
    }
  ],
  "reason_summary_ja": "入力された銀行名に一致する金融機関候補を特定できません"
}

unresolvedでは候補を特定できないため、candidatesは空配列です。best_matchは返りません。

β提供中

β提供条件

Resolve API βは、Freeプランを含むすべての登録ユーザーが、既存のAPIキーで利用できます。正式版の提供開始までは追加料金はかかりません。 利用上限は、アカウント単位で1日10,000リクエスト、秒間1リクエストです。β版の終了日は未定です。提供条件を変更する場合は、事前にお知らせします。

利用開始

対象
Freeプランを含むすべての登録ユーザー
APIキー
既存APIキーで自動的に利用可能
料金
正式版の提供開始まで追加料金なし
上限
アカウント単位で1日10,000リクエスト、秒間1リクエスト
β終了日
未定
FAQ

Resolve API βのよくある質問

Resolve APIとは何ですか?

CSV・OCR・取引先マスタなどの入力から銀行コード・支店コード候補を返し、自動処理に進めるか、人が確認すべきかの判断材料を提供するAPIです。

Search APIが金融機関名・支店名・コードから検索候補を返すAPIであるのに対し、Resolve API βは、入力値の揺れや不足を含むデータから候補を推定し、decision と理由で後続処理の判断を支援します。

Resolve APIは現在正式版ですか?

現在はβ提供中です。β版の終了日は未定です。

提供条件を変更する場合は、事前にお知らせします。

needs_reviewは失敗ですか?

いいえ。needs_review はAPIの失敗ではありません。有力候補はあるものの、人による確認を推奨する状態です。

利用側では、確認画面、選択UI、バックオフィスでの確認対象抽出などに回してください。

auto_confirmとは何ですか?

十分な確度で候補を特定でき、自動処理候補として扱える状態です。

ただし、最終的な業務上の採用判断は、利用システム側の要件や確認フローに合わせて設計してください。

ambiguousとは何ですか?

候補は存在するが、一意に判断できない、または確度が不足している状態です。候補選択、追加入力、人手確認に回してください。

unresolvedとは何ですか?

候補を特定できない状態です。この場合、candidates は空配列で、best_match は返りません。

利用側では入力修正、再入力、または別手段での確認に回してください。

振込用途で使えますか?

利用可能です。振込・支払用途では context: "payment" の利用を推奨します。

振込・支払用途では、APIの判定結果だけで処理を進めるのではなく、利用システム側の確認フローやリスク許容度に合わせて取り扱ってください。

Resolve API βは無料ですか? 利用条件は?

Resolve API βは、Freeプランを含むすべての登録ユーザーが、既存のAPIキーで利用できます。

正式版の提供開始までは追加料金はかかりません。

利用上限は、アカウント単位で1日10,000リクエスト、秒間1リクエストです。

β版の終了日は未定です。提供条件を変更する場合は、事前にお知らせします。

Resolve API β のリクエスト上限は、契約中のプランと同じですか?

同じではありません。Resolve API βの利用上限は、アカウント単位で1日10,000リクエスト、秒間1リクエストです。

Search APIやWidgetの料金・上限は変更ありません。

料金、支払い、Search API、データ更新に関する質問はFAQ一覧をご確認ください。

Start

確認が必要な銀行・支店入力を、Resolve API βで切り分ける。