IBAN Validation API V2 Documentation



API integration specification


1. What is new in V2 IBAN Validation API?


We are constantly working to improve our services and to provide better payment validation solutions.
We have developed a new version of our IBAN Validation API which has some major advantages over the old API.

Here are some of the key features of the V2 API:

Flexible - supports XML and JSON format
Modular - New domestic account level validations have been integrated
Better Structured - We have separated the bank data and validations
Status Codes - Specific status codes have been introduced to ease parsing of errors and validation results.





2. Features


The IBAN Validation API V2 allows you to do the following:


* Bank Code and Account Number validations can be for certain banks and countries only.

3. API V2 Requests


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:

Field Name Length Type Description
IBAN Max 100 String The IBAN you want to validate.
api_key 128 String Your personal API key.
format 5 String Format of the response XML and JSON supported.

*To obtain an API key, please contact us at contact@iban.com or purchase a subscription at our order page

EXAMPLE – Validate an IBAN
An example usage of the IBAN Validation API with a GET request can be found below:

https://api.iban.com/clients/api/ibanv2.php?api_key=key&format=xml&iban=IBAN

Where:

Once an HTTP GET or POST request is made with the correct API key, the system will return the results in the specified format. You can find an sample response in the next section “API Response Structure”



4. API V2 Response


An XSD Schema of the API’s response can be found below:


  
    
      
        
          
            
              
              
              
              
              
              
              
              
              
              
              
              
              
              
            
          
        
        
          
            
              
              
              
              
              
            
          
        
        
          
            
              
                
                  
                    
                    
                  
                
              
            
          
        
        
      
    
  

A detailed description of the bank_data object fields returned can be seen in the table below:
Field Name Length Type Description
BIC Max 11 String The BIC code of the issuing bank/branch or institution.
BANK Max 256 String Bank Code identifying the bank that issued the IBAN
BRANCH Max 256 String Name of the specific bank branch if available
COUNTRY Max 32 String Full name of the country of origin e.g. “United States”
COUNTRY_ISO 2 String Two letter abbreviation of the country code e.g. US, UK, AU, FR … etc.
CITY Max 128 String The name of the city of the issuing bank’s location.
STATE Max 128 String The name of the state in which the bank/branch is located.
ZIP Max 11 String Zip or postal code of the city.
ADDRESS Max 128 String The issuing bank address.
Phone Max 128 String Primary contact phone of the bank/branch.
FAX Max 128 String Primary FAX number for the current bank/branch.
WWW Max 128 String Primary website for the current bank or institution.
EMAIL Max 128 String Primary contact email for the current bank/branch.
ACCOUNT Max 128 String The domestic bank account number extracted from the IBAN.


A detailed description of the sepa_data object fields returned can be seen in the table below:
Field Name Length Type Description
SCT Max 3 String Whether this bank supports SEPA Credit Transfer.
SDD Max 3 String Whether this bank supports SEPA Direct Debit.
COR1 Max 3 String Whether this bank supports SEPA COR1.
B2B Max 3 String Whether this bank supports SEPA Business to Business.
SCC Max 3 String Whether this bank supports SEPA Card Clearing.


A sample XML reply from the API for a IBAN validation query would be:


	
		BARCGB22
		CHELTENHAM
		BARCLAYS BANK PLC
		
Leicester LE87 2BB 0345 7345345 United Kingdom GB 30093459
YES YES YES YES NO 002 Account Number check digit is correct 001 IBAN Check digit is correct 005 IBAN structure is correct 003 IBAN Length is correct




5. API V2 Status Codes


Mathematical check digit validations are returned in the "validations" object


Status Code Type Description
301 Account Error API Key is invalid
302 Account Error Subscription expired
303 Account Error No queries available
304 Account Error You have no access to this API
201 Validation Failed Account Number check digit not correct
202 Validation Failed IBAN Check digit not correct
203 Validation Failed IBAN Length is not correct
205 Validation Failed IBAN structure is not correct
001 Validation Success IBAN Check digit is correct
002 Validation Success Account Number check digit is correct
003 Validation Success IBAN Length is correct
004 Validation Success Account Number does not support check digit
005 Validation Success IBAN structure is correct