IBAN API Lookup Documentations

Our IBAN API lookup function allows you to automate IBAN Lookup by a simple HTTP GET request. For casual user who is not interested to use API, similar function is available in IBAN page.

The function will return the result in either XML or JSON format. You can parse both format easily into various programming languages and platforms.

This page will describe on how to use our IBAN API and the expected result you will receive from our systems.

As part of system security and protection, you require to have an API key in order to access our API function, which will be given once you register for API Access.

How to do IBAN Lookup through API?


IBAN Lookup through our API is very simple. What you need to do is make a GET request.

General API Call Format

The default result format is in XML. If you want to get the result in this format, simply follow the API request as below,


https://api.bank.codes/iban/?format=[FORMAT]&api_key=[API_KEY]&iban=[IBAN]

OR
https://api.bank.codes/iban/[FORMAT]/[API_KEY]/[IBAN]/

Input DataExplanation
[FORMAT]Specify the format of the output. Accept "xml" or "json"
[API_KEY]API Key assign to your account
[IBAN]IBAN which you would like to check.

1. XML Format Example


https://api.bank.codes/iban/?format=xml&api_key=9fc53b3db09ca830488d19546a4fc2a1&iban=BE68539007547034

OR
https://api.bank.codes/iban/xml/9fc53b3db09ca830488d19546a4fc2a1/BE68539007547034/

Expected Result in XML


<?xml version="1.0" encoding="utf-8"?>
<result>
  <validation>
    <iban_validity>Valid</iban_validity>
    <iban_checksum>Valid</iban_checksum>
    <iban_length>Valid</iban_length>
    <iban_structure>Valid</iban_structure>
    <account_checksum>Valid</account_checksum>
  </validation>
  <data>
    <iban>BE68539007547034</iban>
    <iban_paper>BE68 5390 0754 7034</iban_paper>
    <bban>539007547034</bban>
    <countrycode>BE</countrycode>
    <checksum>68</checksum>
    <bank_code>539</bank_code>
    <account_number>0075470</account_number>
    <check_digit>34</check_digit>
    <country>Belgium</country>
    <sepa>Yes</sepa>
    <currency>EUR</currency>
  </data>
</result>

2. JSON Format Example


https://api.bank.codes/iban/?format=json&api_key=9fc53b3db09ca830488d19546a4fc2a1&iban=BE68539007547034

OR
https://api.bank.codes/iban/json/9fc53b3db09ca830488d19546a4fc2a1/BE68539007547034/

Expected Result in JSON


{
  "result": {
    "validation": {
      "iban_validity": "Valid",
      "iban_checksum": "Valid",
      "iban_length": "Valid",
      "iban_structure": "Valid",
      "account_checksum": "Valid"
    },
    "data": {
      "iban": "BE68539007547034",
      "iban_paper": "BE68 5390 0754 7034",
      "bban": "539007547034",
      "countrycode": "BE",
      "checksum": "68",
      "bank_code": "539",
      "account_number": "0075470",
      "check_digit": "34",
      "country": "Belgium",
      "sepa": "Yes",
      "currency" : "EUR"
    }
  }
}

3. Error Messages

In some cases, the API may return a response containing error message. Below you can find a description of all possible error messages.

Error IDError MessageExplanation
2001API Key Not SpecifiedYou need to specify your API Key while making API request. Kindly check the API Key in user area.
2002Invalid API KeyPlease make sure that you specify the correct API Key assign to your account. Kindly check the correct API Key in user area.
2003Suspended API KeyYour API Key was suspended due to system abuse. Kindly contact support.
2004IBAN Not SpecifiedYou need to specify IBAN you want to check.
2005Invalid IBANPlease make sure that you specify IBAN in the correct format or structure. Kindly, refer to IBAN Structure page.