API Documentation & Guides
SWIFT / BIC Code Validation API
How to integrate SWIFT / BIC API in your application
Click here to download this guide as a PDF file
When processing wire payments and dealing with bank related transactions, providing the correct BIC / SWIFT code is needed for successful payments. We provide a powerful and simple way of validating BIC / SWIFT CODES automatically. This service allows you to integrate our BIC / SWIFT code directory lookup in your own applications.
Features
Retrieve information about the bank / branch based on the BIC
Retrieve information about the BIC based on the bank name and country
Use xml and json simplified API responses for easier integration
API USAGE
The BIC / SWIFT API is REST based and supports simple HTTP POST requests.
The accepted parameters are listed in the table below:
Field Name |
Length |
Type |
Description |
bic |
11 |
String |
BIC / SWIFT code to look up. Can be 8 or 11 characters |
bank_name |
255 |
String |
Part of a bank name to perform search in the BIC directory |
country |
2 |
String |
Two letter country code. Required when searching by bank name |
api_key |
255 |
String |
Your personal API key. |
format |
4 |
String |
Required to specify the format of the returned data. Currently supported values: xml, json |
limit |
Integer |
Optional: can be used to limit the number of results |
|
hist |
Integer |
Optional: can be used to display historical records from the database |
API Endpoint
You can test our API using swagger by visiting below link
https://api.bicsearch.com/swagger
https://api.bicsearch.com/admincp/Api/branchinfo/
API JSON Response Structure
{
“bicdata”: [
{
“bic”: “LUMIUS3NMIA”,
“institution_name”: “BANK LEUMI USA”,
“institution_type”: “FINANCIAL”,
“op_address”: “350 MADISON AVENUE, FLOOR 3, “,
“op_city”: “NEW YORK,NY”,
“op_zip_code”: “”,
“br_address”: “800 BRICKELL AVE., SUITE 1400, “,
“br_city”: “MIAMI,FL”,
“br_zip_code”: “”,
“country_name”: “UNITED STATES OF AMERICA”,
“iso_country_code”: “US”,
“operationally_active_record”: “Y”
}
]
}
API XML Response Structure
<?xml version=”1.0″ encoding=”utf-8″?>
<result>
<bicdata>
<row>
<bic>LUMIUS3NMIA</bic>
<institution_name>BANK LEUMI USA</institution_name>
<institution_type>FINANCIAL</institution_type>
<op_address>350 MADISON AVENUE, FLOOR 3, </op_address>
<op_city>NEW YORK,NY</op_city>
<op_zip_code/>
<br_address>800 BRICKELL AVE., SUITE 1400, </br_address>
<br_city>MIAMI,FL</br_city>
<br_zip_code/>
<country_name>UNITED STATES OF AMERICA</country_name>
<iso_country_code>US</iso_country_code>
<operationally_active_record>Y</operationally_active_record>
</row>
</bicdata>
</result>
API Errors
In case of an error the API returns an response containing the error message.
Below you can find a description of all possible error messages that could be returned:
Status Code |
Type |
Description |
301 |
Account Error |
API Key is invalid |
302 |
Account Error |
API key is expired |
401 |
Input Error |
Accepted SWIFT length 8 or 11 characters |
403 |
Input Error |
Country code is incorrect! Allowed is 2 letter country code. Example: UK, DE, FR |