BankcodeJP API Docs¶
BankcodeJP API が提供する各種 API / SDK の公式ドキュメントです。
金融機関・支店データを扱うための 検索 API / リゾルブ API (準備中) / 品質チェック SDK (準備中) を中心に、実装者向けの情報を体系的に整理しています。
このドキュメントについて¶
このドキュメントは、
実装者が「いま何を知るべきか」「どこを参照すべきか」を
最短で判断できるように構成されています。
提供中のサービス¶
🔍 Search API（金融機関・支店検索）¶
金融機関コード・名称・ふりがな等をもとに、
金融機関・支店を検索するための API です。
- 金融機関一覧 / 取得
- 支店一覧 / 取得
- 曖昧検索（freeword）
- カーソルベースページング
- フィルタ・部分応答・並び替え
詳細な仕様、エンドポイント、レスポンス例については、
Search API セクションで解説しています。
🧭 Resolve API（コード解決 API）※準備中¶
曖昧な名称入力や不完全な情報から、
金融機関コード・支店コードを 業務用途向けに安全に解決する API です。
- 複数候補の評価
- 判定理由・スコアの可視化
- 業務フロー向けの決定支援
現在は内部検証フェーズであり、API仕様およびドキュメントは、順次公開予定です。
🧪 Name Quality SDK（名義品質チェック）※準備中¶
OCR 等で取得した口座名義を対象に、
自動処理してよいか / 人手確認が必要かを判定する SDK です。
本 SDK は 外部通信を行わないローカル実行前提で設計されており、
金融・業務システムへの安全な組み込みを想定しています。
- 全銀協フォーマット前提のチェック
- 業務用途別プロファイルによる判定切り替え
- 監査・ログ対応を前提とした設計
- ネットワーク非依存（完全ローカル実行）
現在開発中であり、SDK 本体およびドキュメントは、順次公開予定です。
今後追加予定の内容¶
今後、以下のような内容を段階的に追加していく予定です。
- 金融機関データの構造と設計思想
- データ更新ポリシー・反映タイミング
- 非互換変更（Breaking Change）の考え方
- 業務システムでの安全な組み込み指針
単なる API リファレンスにとどまらず、
「なぜこの仕様なのか」「どう使うと事故らないか」まで含めて整理していきます。