継続運用
Search API v1公開以来、金融機関・支店情報を扱うAPIとして継続提供しています。
BankcodeJP APIは、金融機関・支店マスタを検索する Search API と、 入力された銀行名・支店名から自動確定可否を判定する Resolve API β を提供する、 銀行・支店情報向けの業務APIです。
金融機関選択フォーム、取引先登録、CSV/OCR取込、振込・支払先登録など、 銀行・支店情報を扱う業務を、誤確定リスクを抑えながら自動化できます。
{
"decision": "needs_review",
"best_match": {
"bank_code": "0038",
"branch_code": "208",
"bank_name": "住信SBIネット銀行",
"branch_name": "USEN支店"
},
"reason_codes": [
"branch_alias_ambiguous",
"gap_too_small"
]
} 曖昧な入力は auto_confirm せず、needs_review へ。
Search API v1公開以来、金融機関コード・支店コードを扱う業務APIとして継続運用されています。
BankcodeJP APIは、口座入力フォーム、取引先登録、支払先登録、決済・バックオフィス業務など、 銀行・支店情報が必要なシステムへの組み込み用途で利用されています。
金融機関・支店情報の更新、検索性の改善、入力値の確定判定ロジックの改善を継続し、 開発・検証から商用利用まで段階的に導入できるAPIとして提供しています。
Search API v1公開以来、金融機関・支店情報を扱うAPIとして継続提供しています。
口座入力フォーム、取引先登録、支払先登録、決済・バックオフィス業務などで利用されています。
金融機関・支店情報の変更を収集・確認し、APIデータへの反映を継続的に行っています。
Search APIによる検索に加え、Resolve API βで自由入力値の自動確定可否を判定できます。
銀行名・支店名には、略称、省略、表記ゆれ、同名支店が多く存在します。 単に「一番近い候補」を返すだけでは、取引先登録や振込・支払業務で誤登録・誤振込につながる可能性があります。
検索結果を返すだけでは、業務事故は防げません。BankcodeJPは「探す」と「確定してよいか判断する」を分けて提供します。
BankcodeJP APIは、ベースプランに含まれるSearch APIと、β期間中0円アドオンのResolve API βで構成されています。
ベースプランに含まれるAPIです。
候補を返すだけではなく、自動処理してよい入力と人手確認に回すべき入力を分けます。β期間中0円アドオンとして利用できます。
| API | できること | 主な用途 |
|---|---|---|
| Search API | 金融機関・支店を検索する | 金融機関選択UI、支店検索、マスタ参照 |
| Resolve API β | 入力値から候補を推定し、誤確定リスクを抑えるために自動確定可否を判定する | 自由入力、CSV/OCR取込、振込・支払、名寄せ |
銀行選択、支店検索、金融機関マスタ参照に利用できます。Search APIはベースプランに含まれます。
銀行、信用金庫、信用組合、労働金庫、農協などの金融機関情報と支店情報をAPIで検索できます。
金融機関コード、支店コード、名称、読み、金融機関種別などを利用でき、 金融機関選択UIや支店検索機能を短期間で実装できます。
GET /v3/banks
GET /v3/banks/{bank_code}/branches 銀行名・読み・金融機関コードから金融機関を検索し、選択した金融機関に紐づく支店一覧を表示できます。
自由入力やCSV/OCR由来の曖昧な入力は、検索だけでは安全に処理できません。Resolve API βは、候補を返すだけではなく、自動処理してよい入力と、人手確認に回すべき入力を分けて返します。β期間中0円アドオンです。
Search APIで候補を探し、Resolve API βで「自動処理してよいか」を判定します。
Resolve API βは、自由入力された銀行・支店名を、誤確定リスクを抑えながらコード化するためのAPIです。
Resolve API βは、ユーザーが入力した銀行名・支店名から銀行コード・支店コード候補を推定し、 その結果を自動確定してよいかを decision として返します。
曖昧な略称や複数候補が存在する場合は needs_review を返し、誤確定リスクを抑えます。
Resolve APIは、候補を当てるだけではなく、自動確定すべきでない入力を人手確認に回すことを重視しています。 これは失敗ではなく、誤登録・誤振込のリスクを抑えるための安全設計です。
| decision | 意味 | 利用側の処理 |
|---|---|---|
| auto_confirm | 自動確定可能 | 自動登録・自動処理へ |
| needs_review | 候補はあるが確認が必要 | 候補表示・人手確認へ |
| ambiguous | 候補なし、または判断困難 | 再入力・選択UIへ |
「USEN」と入力されたとき、すぐに確定してよいとは限りません。
decision が needs_review の場合は、候補を表示して人手確認に回す前提で扱います。
{
"bank_name": "住信SBIネット銀行",
"branch_name": "USEN"
} {
"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"
],
"reason_summary_ja": "入力された支店名略称が同一銀行内の複数支店に該当する可能性があるため、自動確定を避けました",
"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法人支店"
}
]
} USEN支店とUSEN法人支店の両方に該当する可能性があるため、自動確定を避けます。
{
"bank_name": "住信SBIネット銀行",
"branch_name": "USEN支店"
} {
"decision": "auto_confirm",
"best_match": {
"bank_code": "0038",
"bank_name": "住信SBIネット銀行",
"branch_code": "208",
"branch_name": "USEN支店"
}
} 支店名が正式に指定されているため、自動確定可能な候補として返します。
全国銀行協会内の金融機関共同コード管理委員会が制定する、金融機関に付与されたコードを元に、 APIで利用しやすい形で提供します。
各金融機関が定める支店コード・支店名を収集・確認し、 検索・参照・確定判定に利用できる形で提供します。
金融機関コードデータベースや支店マスタを自前で収集・更新・API化する必要はありません。 BankcodeJP APIが金融機関・支店情報を更新し、Search API / Resolve APIから利用できる形で提供します。
金融機関・支店情報の収集・更新運用を削減できます。
月額固定のベースプランと、必要に応じたアドオンで利用できます。
JSONレスポンス、APIキー認証、明確なドキュメントで短期間に組み込めます。
BankcodeJP APIは、開発・検証用途だけでなく、商用システムへの組み込み用途でも利用されています。 銀行・支店情報を扱う入力フォーム、取引先登録、支払先登録、決済・バックオフィス業務などでの利用を想定しています。
銀行・支店名には、似た名前や略称が多く存在します。
BankcodeJP Resolve API βは、候補を当てるだけではなく、自動確定すべきでない入力を人手確認に回すことを重視しています。
Search API / Resolve API β は、APIキー認証とJSONレスポンスで利用できます。
curl -s "https://apis.bankcode-jp.com/v3/banks?limit=10" \
-H "X-API-KEY: ${BANKCODEJP_API_KEY}" 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"}' FreeプランでAPI仕様・レスポンスを検証し、Standard / Proプランで商用利用へ移行できます。リクエスト上限や利用条件はプランごとに異なりますが、Search APIの基本的なレスポンス形式とデータ内容は共通です。
¥0 / 月
¥3,370 / 月
¥4,980 / 月
表示価格は税抜です。
Search APIはベースプランに含まれます。
Resolve API β は、BankcodeJP API のベースプラン契約者向けに、β期間中0円で提供しています。 Freeプランを含むベースプラン契約中のAPIキーで利用できます。 正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。 正式提供への移行前に、事前にご案内します。
Resolve API βは現在β提供中です。β期間中0円アドオンとして提供します。
Search APIは、金融機関コード、名称、支店コード、読みなどで金融機関・支店情報を検索するAPIです。
Resolve API βは、入力された銀行名・支店名から候補を推定し、自動確定してよいかを decision で返します。確認が必要な場合は needs_review を返します。
API機能・レスポンス品質・データ内容は同一です。差分は、1日あたりのリクエスト上限と秒間リクエスト数(レート制限)です。
開発・本番ともに同一API仕様で利用できます。最新の上限値は料金プランをご確認ください。
定期更新は原則として日次です。品質改善や重要変更がある場合は、臨時更新も随時実施します。
更新中も整合性が保たれるよう、バージョン切替方式で反映します。統廃合・名称変更などの反映は、公開情報側の更新タイミングや検証状況により、一定の遅延が発生する場合があります。
β期間中は0円で提供しています。
Freeプランを含むBankcodeJP APIのベースプラン契約中のAPIキーで利用できます。
正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。
正式提供への移行前に、事前にご案内します。
秒間レート制限を超えた場合、APIは HTTP 429 (Too Many Requests) を返します。一定時間待ってから再試行してください。
クライアント実装では、指数バックオフ(exponential backoff)やリトライ間隔の制御を推奨します。レート制限時のレスポンスには Retry-After ヘッダが含まれます。指定秒数待って再試行してください。
可能です。追加料金・クレジット表記義務はありません(利用規約の範囲内)。商用サービスや社内業務システムで利用できます。
β期間中も商用環境で利用できます。
ただし、β版は仕様・レスポンス形式・利用制限・提供条件が変更される場合があります。
β版を重要な業務フローに組み込む場合は、事前に十分な検証を行ってください。
その他の質問はFAQ一覧をご確認ください。