Resolve APIは、入力された銀行名・支店名から銀行コード・支店コード候補を推定し、 その結果を自動確定してよいかを decision として返します。
POST https://apis.bankcode-jp.com/resolve/v1/bank-branchβ期間中は 0円アドオンとして提供中です。
Search APIは銀行・支店を検索するAPIです。Resolve APIは、自由入力やCSV/OCR由来の入力値から候補を推定し、 自動確定できるかを判定します。
| API | 主な目的 |
|---|---|
| Search API | 銀行・支店を検索する |
| Resolve API | 入力値から候補を推定し、自動確定可否を判断する |
needs_review は失敗ではありません。誤確定を避けるため、候補はあるが人手確認が必要な状態として返します。
| decision | 意味 | 利用側の処理 |
|---|---|---|
| auto_confirm | 自動確定可能 | 自動登録・自動処理へ |
| needs_review | 候補はあるが確認が必要 | 候補表示・人手確認へ |
| ambiguous | 候補なし、または判断困難 | 再入力・選択UIへ |
{
"bank_name": "住信SBIネット銀行",
"branch_name": "USEN",
"context": "default"
}{
"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"
}{
"decision": "auto_confirm",
"best_match": {
"bank_code": "0038",
"bank_name": "住信SBIネット銀行",
"branch_code": "208",
"branch_name": "USEN支店"
},
"reason_codes": [],
}
銀行名・支店名を入力して、Resolve APIの判定結果をその場で確認できます。
この画面ではデモ用のAPIキーで実際のレスポンスを確認できます。
本番利用時は、ダッシュボードで発行したAPIキーを利用してください。
この画面はデモ用APIキーで動作します。
本番サービスで利用するAPIキーは、必要に応じてサーバー側で管理してください。
{
"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 は、自動確定しない理由や補完が入った理由を示します。 人手確認に退避する根拠や、内部統制上の説明に利用できます。
branch_alias_ambiguous 支店名略称が同一銀行内の複数支店に該当する可能性がある
gap_too_small 上位候補と次点候補の差が小さい
generic_branch 汎用的な支店名のため自動確定しない
payment_branch_supplement payment用途で支店名補完を含む
Resolve API β は、BankcodeJP API のベースプラン契約者向けにβ提供中です。
Freeプランを含むベースプラン契約中のAPIキーで、そのまま利用できます。
β期間中は0円で提供します。
正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。
正式提供への移行前に、事前にご案内します。
入力された銀行名・支店名から銀行コード・支店コード候補を推定し、その結果を自動確定してよいかを decision として返すAPIです。
Search APIが金融機関・支店を検索するAPIであるのに対し、Resolve API βは、入力値の揺れや不足を含むデータから候補を推定し、後続処理へ進めてよいかの判断材料を返します。
現在はβ提供中です。β期間中は仕様・レスポンス文言・利用制限・提供条件が調整される場合があります。
正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。
いいえ。needs_review はAPIの失敗ではありません。候補はあるものの、自動確定すると誤確定リスクがあるため、人手確認を要求している状態です。
利用側では、確認画面、選択UI、バックオフィスでの確認対象抽出などに回してください。
自動確定可能と判断された状態です。利用側で自動登録・自動処理に進める候補として扱えます。
ただし、最終的な業務上の採用判断は、利用システム側の要件や確認フローに合わせて設計してください。
候補がない、または安全に判断できない状態です。自動確定せず、再入力や選択UI、人手確認に回してください。
利用可能です。振込・支払用途では context: "payment" の利用を推奨します。
振込・支払用途では、APIの判定結果だけで処理を進めるのではなく、利用システム側の確認フローやリスク許容度に合わせて取り扱ってください。
β期間中は0円で提供しています。
Freeプランを含むBankcodeJP APIのベースプラン契約中のAPIキーで利用できます。
正式提供時には、料金体系・利用制限・提供条件が変更される場合があります。
正式提供への移行前に、事前にご案内します。
料金、支払い、Search API、データ更新に関する質問はFAQ一覧をご確認ください。