🏦

Banking Details API

Save time for creating, verifying, and formatting international bank account information (IBAN, BIC/SWIFT, and BBAN) with our Banking Details API. Handle bank account details processes programmatically and obtain country-specific banking details standards.
You need to provide your API key for every API request you make. Please refer to the Getting Started section for more details.
You can check our Errors section to understand how we handle errors and the responses you will receive in cases when errors occur.
IBAN (International Bank Account Number)
Validate IBAN (/iban/validate)
Endpoint used for checking whether a provided IBAN (International Bank Account Number) has a valid value. 
Request parameters
Key
Explanation
Required
iban
The IBAN value you want to validate.
true
Example
GET /iban/validate?iban=BE68539007547034
​
RESPONSE:
​
{
  "iban": "BE68539007547034",
  "is_valid": true
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
iban
The IBAN value provided in the request
string
is_valid
Indicates whether a provided IBAN value is valid.
boolean
IBAN details (/iban/details)
Endpoint used for getting bank details (BBAN and country) from the IBAN.
Request parameters
Key
Explanation
Required
iban
The IBAN value you want to get details from.
true
Example
GET /iban/details?iban=FR1420041010050500013M02606
​
RESPONSE:
​
{
  "iban": "FR1420041010050500013M02606",
  "bban": "20041010050500013M02606",
  "country": "FR"
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
iban
The IBAN value provided in the request.
string
bban
BBAN value extracted from the provided IBAN.
string
country
Country two-letter code extracted from the provided IBAN. Provided in ISO 3166-1 alpha-2 format.
string
Compose IBAN (/iban/compose)
Endpoint used for generating IBAN value from BBAN and country code.
Request parameters
Key
Explanation
Required
bban
The BBAN (Basic Bank Account Number) value.
true
country
Country two-letter code. provided in ISO 3166-1 alpha-2 format.
true
Example
GET /iban/compose?country=NO&bban=86011117947
​
RESPONSE:
​
{
  "country": "NO",
  "bban": "86011117947",
  "iban": "NO9386011117947"
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
country
Country value provided in the request.
string
bban
BBAN value provided in the request.
string
iban
Generated IBAN value.
string
Electronic IBAN format (/iban/format/electronic)
Endpoint used for converting IBAN values to the electronic format which is used for payment processing.
Request parameters
Key
Explanation
Required
iban
The IBAN value you want to format.
true
Example
GET /iban/format/electronic?iban=FR14-2004-1010-0505-0001-3M02-606
​
RESPONSE:
​
{
  "iban": "FR14-2004-1010-0505-0001-3M02-606",
  "iban_formatted": "FR1420041010050500013M02606"
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
iban
The IBAN value provided in the request.
string
iban_formatted
Electronically formatted IBAN value.
string
Friendly IBAN format (/iban/format/friendly)
Endpoint used for converting IBAN values to the user-friendly format which is usually used for displaying IBAN values in the UI.
Request parameters
Key
Explanation
Required
iban
The IBAN value you want to format.
true
separator
Separator value to use when performing friendly IBAN formatting. If this parameter is not provided in the request it defaults to a single space (" ").
false
Examples
GET /iban/format/friendly?iban=FR1420041010050500013M02606
​
RESPONSE:
​
{
  "iban": "FR1420041010050500013M02606",
  "separator": " ",
  "iban_formatted": "FR14 2004 1010 0505 0001 3M02 606"
}
Our API uses a single space as a default separator for the friendly IBAN format. However, you can specify your custom separator:
GET /iban/format/friendly?iban=FR1420041010050500013M02606&separator=-
​
RESPONSE:
​
{
  "iban": "FR1420041010050500013M02606",
  "separator": "-",
  "iban_formatted": "FR14-2004-1010-0505-0001-3M02-606"
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
iban
The IBAN value provided in the request.
string
separator
Separator used to separate friendly formatted IBAN parts.
string
iban_formatted
Friendly formatted IBAN value.
string
BIC (Business Identifier Code)
Validate BIC (/bic/validate)
Endpoint used for validating BIC values.
Request parameters
Key
Explanation
Required
bic
The BIC value you want to validate.
true
Example
GET /bic/validate?bic=AEBAGRAA
​
RESPONSE:
​
{
  "bic": "AEBAGRAA",
  "is_valid": true
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
bic
The BIC value provided in the request.
string
is_valid
Indicates whether a provided IBAN value is valid.
boolean
BIC details (/bic/details)
Endpoint used for getting bank details from BIC values.
Request parameters
Key
Explanation
Required
bic
The BIC value you want to get details from.
true
Example
GET /bic/details?bic=XCYSCY2N
​
RESPONSE:
​
{
  "bic": "XCYSCY2N",
  "bank_code": "XCYS",
  "country": "CY",
  "location_code": "2N",
  "is_test_bic": false,
  "branch_code": "619"
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
bic
The BIC value provided in the request.
string
bank_code
Bank code of the bank to which the BIC belongs to.
string
country
Country code (provided in ISO 3166-1 alpha-2 format) of the country to which BIC belongs to.
string
location_code
Location code of the institution location to which the BIC is assigned to.
string
is_test_bic
Indicates whether a provided BIC value is assigned to a real banking institution, or it is a test BIC.
boolean
branch_code
Indicates a branch code to which BIC belongs to.
string
BBAN (Basic Bank Account Number)
Validate BBAN (/bban/validate)
Endpoint used for validating BBAN value for a specified country.
Request parameters
Key
Explanation
Required
bban
The BBAN value you want to validate.
true
country
Two-letter country code (provided in ISO 3166-1 alpha-2 format) in which you want to validate BBAN.
true
Example
GET /bban/validate?bban=21000418450200051332&country=ES
​
RESPONSE:
​
{
  "bban": "21000418450200051332",
  "country": "ES",
  "is_valid": true
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
bban
The BBAN value provided in the request.
string
country
Country code (provided in ISO 3166-1 alpha-2 format) specified in the request.
string
is_valid
Indicates whether specified BBAN value is valid.
boolean
Country-specific banking data
Country banking details (/country/details)
Endpoint used for getting country-specific banking details.
Request parameters
Key
Explanation
Required
country
Two-letter country code (provided in ISO 3166-1 alpha-2 format) for which you want to get banking details.
true
Example
GET /country/details?country=DE
​
RESPONSE:
{
  "country": "DE",
  "is_sepa_country": true,
  "is_iban_used": true,
  "iban_length": 22,
  "bban_format": "^[0-9]{18}$"
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
country
Country code (provided in ISO 3166-1 alpha-2 format) specified in the request.
string
is_sepa_country
Indicates whether specified country belongs to Single Euro Payments Area (SEPA).
boolean
is_iban_used
Indicates whether a country uses IBAN. 
boolean
iban_length
Specifies how long is the country's IBAN. This key has null value if the country doesn't use IBAN.
number | null
bban_format
Specified Regular expression (RegEx) of the BBAN. This key has null value if the country doesn't use IBAN.
string | null
Is country in SEPA (/country/is_sepa)
Endpoint used for checking if the country is in the Single Euro Payments Area (SEPA).
Request parameters
Key
Explanation
Required
country
Two-letter country code (provided in ISO 3166-1 alpha-2 format) for which you want to get banking details.
true
Example
GET /country/is_sepa?country=BE
​
RESPONSE:
{
  "country": "BE",
  "is_sepa_country": true
}
Response structure
Every successful response will have the structure explained in the table below:
Key
Explanation
Type
country
Country code (provided in ISO 3166-1 alpha-2 format) specified in the request.
string
is_sepa_country
Indicates whether specified country belongs to Single Euro Payments Area (SEPA).
boolean

Key	Explanation	Required
`iban`	The IBAN value you want to validate.	`true`

Key	Explanation	Type
`iban`	The IBAN value provided in the request	`string`
`is_valid`	Indicates whether a provided IBAN value is valid.	`boolean`

Key	Explanation	Required
`iban`	The IBAN value you want to get details from.	`true`

Key	Explanation	Type
`iban`	The IBAN value provided in the request.	`string`
`bban`	BBAN value extracted from the provided IBAN.	`string`
`country`	Country two-letter code extracted from the provided IBAN. Provided in ISO 3166-1 alpha-2 format.	`string`

Key	Explanation	Required
`bban`	The BBAN (Basic Bank Account Number) value.	`true`
`country`	Country two-letter code. provided in ISO 3166-1 alpha-2 format.	`true`

Key	Explanation	Type
`country`	Country value provided in the request.	`string`
`bban`	BBAN value provided in the request.	`string`
`iban`	Generated IBAN value.	`string`

Key	Explanation	Required
`iban`	The IBAN value you want to format.	`true`

Key	Explanation	Type
`iban`	The IBAN value provided in the request.	`string`
`iban_formatted`	Electronically formatted IBAN value.	`string`

Key	Explanation	Required
`iban`	The IBAN value you want to format.	`true`
`separator`	Separator value to use when performing friendly IBAN formatting. If this parameter is not provided in the request it defaults to a single space (`" "`).	`false`

Key	Explanation	Type
`iban`	The IBAN value provided in the request.	`string`
`separator`	Separator used to separate friendly formatted IBAN parts.	`string`
`iban_formatted`	Friendly formatted IBAN value.	`string`

Key	Explanation	Required
`bic`	The BIC value you want to validate.	`true`

Key	Explanation	Type
`bic`	The BIC value provided in the request.	`string`
`is_valid`	Indicates whether a provided IBAN value is valid.	`boolean`

Key	Explanation	Required
`bic`	The BIC value you want to get details from.	`true`

Key	Explanation	Type
`bic`	The BIC value provided in the request.	`string`
`bank_code`	Bank code of the bank to which the BIC belongs to.	`string`
`country`	Country code (provided in ISO 3166-1 alpha-2 format) of the country to which BIC belongs to.	`string`
`location_code`	Location code of the institution location to which the BIC is assigned to.	`string`
`is_test_bic`	Indicates whether a provided BIC value is assigned to a real banking institution, or it is a test BIC.	`boolean`
`branch_code`	Indicates a branch code to which BIC belongs to.	`string`

Key	Explanation	Required
`bban`	The BBAN value you want to validate.	`true`
`country`	Two-letter country code (provided in ISO 3166-1 alpha-2 format) in which you want to validate BBAN.	`true`

Key	Explanation	Type
`bban`	The BBAN value provided in the request.	`string`
`country`	Country code (provided in ISO 3166-1 alpha-2 format) specified in the request.	`string`
`is_valid`	Indicates whether specified BBAN value is valid.	`boolean`

Key	Explanation	Required
`country`	Two-letter country code (provided in ISO 3166-1 alpha-2 format) for which you want to get banking details.	`true`

Key	Explanation	Type
`country`	Country code (provided in ISO 3166-1 alpha-2 format) specified in the request.	`string`
`is_sepa_country`	Indicates whether specified country belongs to Single Euro Payments Area (SEPA).	`boolean`
`is_iban_used`	Indicates whether a country uses IBAN.	`boolean`
`iban_length`	Specifies how long is the country's IBAN. This key has `null` value if the country doesn't use IBAN.	`number` \| `null`
`bban_format`	Specified Regular expression (RegEx) of the BBAN. This key has `null` value if the country doesn't use IBAN.	`string` \| `null`

Key	Explanation	Required
`country`	Two-letter country code (provided in ISO 3166-1 alpha-2 format) for which you want to get banking details.	`true`

Key	Explanation	Type
`country`	Country code (provided in ISO 3166-1 alpha-2 format) specified in the request.	`string`
`is_sepa_country`	Indicates whether specified country belongs to Single Euro Payments Area (SEPA).	`boolean`

Phone Validator API

Loan Generator API

Last modified 1yr ago