API integration specification
1. What is the Reverse IBAN Validation API?
Reverse IBAN is an online system, which provides businesses with an online interface where they can perform real-time IBAN validation and identification.
Those functions come in the form of add-on modules, which expand the functionality of your portal.
The International Bank Account Number or IBAN is a standardized way of explaining a bank account number that works across borders.
Its structure is:
<Two Letter ISO Country Code> + <Two Digit Checksum] + <BBAN>
BBAN is the term used to describe the national-level format for a bank account number, which varies between countries (and was sometimes created just to get IBAN connectivity!).
Note that a BBAN may have its own checksum algorithm.
IBAN provides basic protection, using the checksum, against transcription (ie: human copying) errors. It also provides a registry of valid destination countries and their BBAN formats.
Thus, when you ask the IBAN API module to 'validate' an IBAN it ensures that these checks are passed.
However, it cannot ensure that a bank account actually exists - the only party who can do that is the receiving bank or country.
The Reverse IBAN Validation API allows you to do the following queries:
- Validate if an IBAN is valid using it’s check digits
- Identify the bank which issued the IBAN
- Identify the country and country code of an IBAN
- Identify address of the bank issued the IBAN
- Identify if the IBAN supports SEPA payments
- Identify bank’s SWIFT code
3. API Usage
The API system allows you to automate IBAN validation via a simple HTTP GET or POST request.
The accepted parameters are listed in the table below:
|IBAN||Max 100||String||The IBAN you want to validate.|
|api_key||128||String||Your personal API key.|
*To obtain an API key, please contact us at email@example.com or the
EXAMPLE – Validate an IBAN
An example usage of the IBAN Validation API with a GET request can be found below:
- key is your API key
- IBAN sent for validation by the API module.
Once an HTTP GET or POST request is made with the correct API key, the system will return the results in an XML format. You can find an example XML response in the next section “API XML Response Structure”
4. API XML Response Structure
An XML Schema of the API’s response can be found in the documentation archive.
A detailed description of the fields returned can be seen in the table below:
|IBAN||Max 100||String||The IBAN you submitted is displayed.|
|BANK_NAME||256||String||Bank Code identifying the bank owning the IBAN|
|SEPA||5||String||Indicator if this IBAN support’s SEPA payments. Values True or False|
|COUNTRY||32||String||Full name of the country of origin e.g. “United States”|
|COUNTRY_CODE||2||String||Two letter abbreviation of the country code e.g. US, UK, AU, FR … etc.|
|CITY||128||String||The name of the city of the issuing bank’s location.|
|ADDRESS||128||String||The issuing bank address.|
|SWIFT||128||String||The issuing bank SWIFT code.|
|VALID||5||String||True/False result if the IBAN checksums are correct.|
The API system returns results in XML format, which is easy to parse in a variety of programming languages and platforms.
A sample XML reply from the API for a IBAN validation query would be:
<bank_name>DEUTSCHE BANK AG</bank_name>
<city>60262 FRANKFURT AM MAIN</city>
5. API Errors
In case of an error the IBAN API returns an XML response containing the error message.
The <error></error> XML tags are returned without any other fields in the XML response.
Below you can find a description of all possible error messages that could be returned:
<error>Invalid API Key</error>
<error>No IBAN specified</error>