IBAN検証

GET

iban

IBAN検証

curl --request GET \
  --url https://bankvalidation.cleariflow.com/v1/iban/

import requests

url = "https://bankvalidation.cleariflow.com/v1/iban/"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://bankvalidation.cleariflow.com/v1/iban/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://bankvalidation.cleariflow.com/v1/iban/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://bankvalidation.cleariflow.com/v1/iban/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://bankvalidation.cleariflow.com/v1/iban/")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://bankvalidation.cleariflow.com/v1/iban/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

はじめに

ベースURL

https://bankvalidation.cleariflow.com/v1/iban/

検証エンドポイント

ibanエンドポイントには、APIキーとIBANパラメータが必要です。国際銀行口座番号（IBAN）の包括的な検証を行います。

https://bankvalidation.cleariflow.com/v1/iban/
? api_key = YOUR_UNIQUE_API_KEY
& iban = DE89370400440532013000

この成功したリクエストは、ドイツのIBANを検証し、詳細情報を返します。

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

リクエストパラメータ

api_key

String

必須

固有のAPIキーです。各ユーザーはCleariflowの各APIごとに固有のAPIキーを持っているため、銀行検証APIのキーは為替レートAPIなどでは動作しません。

iban

String

必須

検証する国際銀行口座番号（IBAN）です。スペースは許可され、処理中に自動的に削除されます。IBANはISO 13616標準フォーマットに従う必要があります。

レスポンスパラメータ

APIレスポンスは、汎用的で軽量な JSON形式で返されます。

iban

String

スペースを除いた正規化されたIBANで、大文字形式で返されます。

is_valid

Boolean

すべての検証ルールに従ってIBANが有効かどうかを示す総合的な検証結果です。

country_code

String

2文字のISO国コードです（例：ドイツはDE、フランスはFR）。

country_name

String

IBANに関連する国の正式名称です。

bank_code

String

国の固有フォーマットに従ってIBANから抽出された銀行識別コードです。

account_number

String

国コード、チェックサム、銀行コードを除いたIBANの口座番号部分です。

length

Integer

提供されたIBANの実際の長さです。

expected_length

Integer

ISO 13616標準に従った特定の国のIBANの期待される長さです。

checksum_valid

Boolean

MOD-97アルゴリズムを使用したIBANチェックサム検証が合格したかどうかです。

format_valid

Boolean

IBANフォーマットが国の期待される構造と一致するかどうかです。

details

Object

IBANの構造とフォーマットに関する追加の詳細情報です。

details.structure

String

B（銀行）、S（ソート）、C（顧客）、K（キー）のプレースホルダーを使用したIBAN構造の視覚的表現です。

details.example

String

読みやすさのためにスペースを入れたIBANの適切にフォーマットされた例です。

details.bank_name

String

銀行名です（現在は「Bank information not available」と表示されます）。

details.bank_bic

String

銀行のBICコードです（現在は「BIC not available」と表示されます）。

details.account_type

String

口座のタイプです（通常は「Bank Account」）。

details.currency

String

国の通貨コードです（例：ユーロ圏はEUR、英国はGBP）。

例

有効なドイツのIBAN

リクエスト：

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY&iban=DE89370400440532013000

レスポンス：

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

有効なフランスのIBAN

リクエスト：

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY&iban=FR1420041010050500013M02606

レスポンス：

{
  "iban": "FR1420041010050500013M02606",
  "is_valid": true,
  "country_code": "FR",
  "country_name": "France",
  "bank_code": "2004101005",
  "account_number": "0500013M02606",
  "length": 27,
  "expected_length": 27,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BSSS SSCC CCCC CCCC CCC KK",
    "example": "FR14 2004 1010 0505 0001 3M02 606",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

無効なIBAN

リクエスト：

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY&iban=INVALID

レスポンス：

{
  "iban": "",
  "is_valid": false,
  "country_code": "",
  "country_name": "",
  "bank_code": "",
  "account_number": "",
  "length": 7,
  "expected_length": 0,
  "checksum_valid": false,
  "format_valid": false,
  "details": {
    "structure": "",
    "example": ""
  }
}

エラーハンドリング

IBANパラメータの欠落

リクエスト：

GET https://bankvalidation.cleariflow.com/v1/iban/?api_key=YOUR_API_KEY

レスポンス：

{
  "error": {
    "message": "Missing iban",
    "code": "missing_iban"
  }
}

APIキーの欠落

リクエスト：

GET https://bankvalidation.cleariflow.com/v1/iban/?iban=DE89370400440532013000

レスポンス：

{
  "error": {
    "message": "API key is required",
    "code": "missing_api_key"
  }
}

IBANの構造

IBANはいくつかのコンポーネントで構成されます：

国コード（2文字）：ISO 3166-1 alpha-2国コード
チェックディジット（2文字）：MOD-97アルゴリズムによる検証
銀行識別子：国別の銀行コード
口座番号：顧客口座識別子

国別フォーマット

国によってIBANの構造は異なります：

ドイツ（DE）：22文字 - BBBB BBBB BBBB BBBB BB
フランス（FR）：27文字 - BBBB BSSS SSCC CCCC CCCC CCC KK
イタリア（IT）：27文字 - CAAA AABB BBSS CCCC CCCC CCX
イギリス（GB）：22文字 - BBBB SSSS SSCC CCCC CC
スペイン（ES）：24文字 - BBBB SSSS DDCC CCCC CCCC CC

記号の意味：

B = 銀行コード
S = ソートコード
C = 顧客口座番号
K = キー/チェックディジット
A = 口座タイプ
D = コントロールディジット

検証ルール

APIは次を含む包括的な検証を実行します：

フォーマット検証：IBANが国の期待される構造に従っているか確認
長さの検証：IBANの長さが国の標準と一致するか確認
チェックサム検証：MOD-97アルゴリズムによる検証を実行
国コード検証：国コードがサポートされていることを確認
文字検証：有効な英数字文字を確認

サポート対象国

APIは50か国以上のIBAN検証をサポートしており、以下を含みます：

ヨーロッパ：ドイツ、フランス、イタリア、スペイン、オランダ、ベルギー、オーストリア、スイス、英国、ポーランド
アジア：UAE、バーレーン、イスラエル、ヨルダン、カザフスタン、クウェート
アメリカ大陸：ブラジル、コスタリカ、ドミニカ共和国、グアテマラ
アフリカ：モーリタニア、モーリシャス、チュニジア

サポート対象国の完全なリストはサポート対象国ページを参照してください。

BIC検証`bic`エンドポイントはビジネス識別コード（BIC）を検証し、国際銀行業務向けに銀行コード、国情報、機関タイプの詳細な内訳を提供します。

IBAN検証

curl --request GET \
  --url https://bankvalidation.cleariflow.com/v1/iban/

import requests

url = "https://bankvalidation.cleariflow.com/v1/iban/"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://bankvalidation.cleariflow.com/v1/iban/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://bankvalidation.cleariflow.com/v1/iban/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://bankvalidation.cleariflow.com/v1/iban/"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://bankvalidation.cleariflow.com/v1/iban/")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://bankvalidation.cleariflow.com/v1/iban/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "iban": "DE89370400440532013000",
  "is_valid": true,
  "country_code": "DE",
  "country_name": "Germany",
  "bank_code": "37040044",
  "account_number": "0532013000",
  "length": 22,
  "expected_length": 22,
  "checksum_valid": true,
  "format_valid": true,
  "details": {
    "structure": "BBBB BBBB BBBB BBBB BB",
    "example": "DE89 3704 0044 0532 0130 00",
    "bank_name": "Bank information not available",
    "bank_bic": "BIC not available",
    "account_type": "Bank Account",
    "currency": "EUR"
  }
}

検証

ルックアップ

作成

はじめに

ベースURL

検証エンドポイント

リクエストパラメータ

レスポンスパラメータ

例

有効なドイツのIBAN

有効なフランスのIBAN

無効なIBAN

エラーハンドリング

IBANパラメータの欠落

APIキーの欠落

IBANの構造

国別フォーマット

検証ルール

サポート対象国

​はじめに

​ベースURL

​検証エンドポイント

​リクエストパラメータ

​レスポンスパラメータ

​例

​有効なドイツのIBAN

​有効なフランスのIBAN

​無効なIBAN

​エラーハンドリング

​IBANパラメータの欠落

​APIキーの欠落

​IBANの構造

​国別フォーマット

​検証ルール

​サポート対象国

はじめに

ベースURL

検証エンドポイント

リクエストパラメータ

レスポンスパラメータ

例

有効なドイツのIBAN

有効なフランスのIBAN

無効なIBAN

エラーハンドリング

IBANパラメータの欠落

APIキーの欠落

IBANの構造

国別フォーマット

検証ルール

サポート対象国