β提供中 Resolve API

曖昧な銀行・支店名を、自動確定してよいか判定。

Resolve APIは、入力された銀行名・支店名から銀行コード・支店コード候補を推定し、 その結果を自動確定してよいかを decision として返します。

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

β期間中は 0円アドオンとして提供中です。

Overview

Search APIとの違い

Search APIは銀行・支店を検索するAPIです。Resolve APIは、自由入力やCSV/OCR由来の入力値から候補を推定し、 自動確定できるかを判定します。

API主な目的
Search API銀行・支店を検索する
Resolve API入力値から候補を推定し、自動確定可否を判断する
Decision

decisionで後続処理を分岐できます。

needs_review は失敗ではありません。誤確定を避けるため、候補はあるが人手確認が必要な状態として返します。

decision意味利用側の処理
auto_confirm自動確定可能自動登録・自動処理へ
needs_review候補はあるが確認が必要候補表示・人手確認へ
ambiguous候補なし、または判断困難再入力・選択UIへ
Samples

USEN / USEN支店 の判定例

リクエスト

{
  "bank_name": "住信SBIネット銀行",
  "branch_name": "USEN",
  "context": "default"
}

needs_review レスポンス

{
  "decision": "needs_review",
  "best_match": {
    "bank_code": "0038",
    "bank_name": "住信SBIネット銀行",
    "branch_code": "208",
    "branch_name": "USEN支店"
  },
  "reason_codes": [
    "branch_alias_ambiguous",
    "gap_too_small"
  ]
}

正式な支店名のリクエスト

{
  "bank_name": "住信SBIネット銀行",
  "branch_name": "USEN支店",
  "context": "default"
}

auto_confirm レスポンス

{
  "decision": "auto_confirm",
  "best_match": {
    "bank_code": "0038",
    "bank_name": "住信SBIネット銀行",
    "branch_code": "208",
    "branch_name": "USEN支店"
  },
  "reason_codes": [],
}
Playground

ブラウザでResolve APIを試す

銀行名・支店名を入力して、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支店"
  },
  "reason_codes": [
    "branch_alias_ambiguous",
    "gap_too_small"
  ],
  "candidates": [
    {
      "bank_code": "0038",
      "bank_name": "住信SBIネット銀行",
      "branch_code": "208",
      "branch_name": "USEN支店"
    },
    {
      "bank_code": "0038",
      "bank_name": "住信SBIネット銀行",
      "branch_code": "209",
      "branch_name": "USEN法人支店"
    }
  ]
}
reason_codes

判定理由を業務フローの説明に利用できます。

reason_codes は、自動確定しない理由や補完が入った理由を示します。 人手確認に退避する根拠や、内部統制上の説明に利用できます。

branch_alias_ambiguous

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

gap_too_small

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

generic_branch

汎用的な支店名のため自動確定しない

payment_branch_supplement

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

β提供中

β提供条件

Resolve API β は、BankcodeJP API のベースプラン契約者向けにβ提供中です。 Freeプランを含むベースプラン契約中のAPIキーで、そのまま利用できます。
β期間中は0円で提供します。 正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。 正式提供への移行前に、事前にご案内します。

FAQ

Resolve API βのよくある質問

Resolve APIとは何ですか?

入力された銀行名・支店名から銀行コード・支店コード候補を推定し、その結果を自動確定してよいかを decision として返すAPIです。

Search APIが金融機関・支店を検索するAPIであるのに対し、Resolve API βは、入力値の揺れや不足を含むデータから候補を推定し、後続処理へ進めてよいかの判断材料を返します。

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

現在はβ提供中です。β期間中は仕様・レスポンス文言・利用制限・提供条件が調整される場合があります。

正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。

needs_reviewは失敗ですか?

いいえ。needs_review はAPIの失敗ではありません。候補はあるものの、自動確定すると誤確定リスクがあるため、人手確認を要求している状態です。

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

auto_confirmとは何ですか?

自動確定可能と判断された状態です。利用側で自動登録・自動処理に進める候補として扱えます。

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

ambiguousとは何ですか?

候補がない、または安全に判断できない状態です。自動確定せず、再入力や選択UI、人手確認に回してください。

振込用途で使えますか?

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

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

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

β期間中は0円で提供しています。

Freeプランを含むBankcodeJP APIのベースプラン契約中のAPIキーで利用できます。

正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。

正式提供への移行前に、事前にご案内します。

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

Start

銀行・支店情報を扱う業務を、検索から確定判定までAPIで。