Bank Suite API Documentation

1. Introduction

The Bank Suite is a web service which provides validation capabilities for bank codes and account numbers.
Designed mainly to provide bank code and account number validation for countries which do not use the IBAN standard (see list of countries ).
Powered by the one of the largest and up to date bank code directories in the industry it is a powerful suit of services helping businesses improve the quality of international payments

2. Features

Some of the key features and benefits of the Bank Suite service are:

Global Coverage

Validate Bank Codes for non-IBAN and IBAN countries

Validate domestic bank code and account number check digits

Monthly updated world bank directory covering 195 countries

Query the bank suite directory by Bank Code(National ID)

Query the bank suite directory by BIC code

Validate Bank Code structure

Validate Bank Code length

3. API Endpoints

This endpoint is used to validate bank codes and retrieve information about the bank and branch they belong.
It also provides an additional feature to validate bank account numbers by checking their structure, formatting, length and check digit.

This endpoint performs validation on a provided BIC code and performs a search in our banking directory.
If the BIC is currently active and in use, the system will provide bank code and bank and branch information related to this BIC

4.2 Bank Code API Errors

We utilize two types of errors for this endpoint.
"Query Failed" error indicates that validations were not carried out.
"Validation failed" error indicates that the bank code or account number submitted has failed a validation step.

Error Code

HTTP Status Code

Type

Message

301

403

Query failed

API Key is invalid

305

403

Query failed

IP Address not allowed

304

403

Query failed

You have no access to this API

302

403

Query failed

Subscription expired

303

403

Query failed

No queries available

306

400

Query failed

Bad Request. Required minimum parameters: api_key; format; iso; nid

806

400

Query failed

Invalid value for 'limit' parameter

500

500

Query failed

Internal Server Error

801

200

Validation failed

Invalid Characters in NID

802

200

Validation failed

Country ISO code invalid

803

200

Validation failed

Unsupported country ISO code

804

200

Validation failed

NID length is not correct for US Accepted length for US: 9 characters.

805

200

Validation failed

Invalid NID format. Example: 211770093

400

200

Validation failed

BankCode(NID) not found in the official directory

809

200

Validation failed

Invalid Characters in account

810

200

Validation failed

Country ISO code invalid

811

200

Validation failed

Account Number length is not correct for US

812

200

Validation failed

Invalid Account format. Example: 39581126

813

200

Validation failed

Invalid Account Check Digit

814

200

Validation failed

Invalid Bank Code/NID Check Digit

5. BIC API Input

The BIC Code endpoint is designed to locate a bank code from a given BIC code in the Bank Suite directory.
The input parameters are listed in the table below:

5.2 BIC API Errors

We utilize two types of errors for this endpoint.
"Query Failed" error indicates that validations were not carried out.
"Validation failed" error indicates that the bank code or account number submitted has failed a validation step.

Error Code

HTTP Status Code

Type

Message

301

403

Query failed

API Key is invalid

305

403

Query failed

IP Address not allowed

304

403

Query failed

You have no access to this API

302

403

Query failed

Subscription expired

303

403

Query failed

No queries available

306

400

Query failed

Bad Request. Required minimum parameters: api_key; format; iso; nid

806

400

Query failed

Invalid value for 'limit' parameter

500

500

Query failed

Internal Server Error

807

200

Validation failed

Invalid Characters in BIC

808

200

Validation failed

BIC length is not correct. BIC code must be 11 characters long

400

200

Validation failed

BIC not found in official directory

6. STRUCTURE API Input

The Structure endpoint is designed to provide bank code formatting information for a specified country code.
The input parameters are listed in the table below:

This field provides the 8 digit part of the BIC code assigned for this bank/branch.
BIC (party prefix, country, and party suffix) where:
• party prefix (4 char)
• country code (2 char)
• party suffix (2 char)

branch_bic

Alphanumeric

3

Contains the BIC branch identifier associated with the 8-character BIC. If no branch identifier exists, then XXX is used.

bic

Alphanumeric

11

Contains the full 11 character BIC code assigned to the specific bank/branch.

chips_uid

Numeric

6

This is the CHIPS Universal ID related to the institution.

national_id

Alphanumeric

15

This is the National identifier aka Bank Code of the institution/branch.

connected_bic

Alphanumeric

1

For a BIC in the field BIC that is not connected to the SWIFT network.
This is the connected BIC of the same institution, if available, or of its correspondent through which it connects.

institution_name

Any

105

Contains the trading name of the bank/institution

branch_information

Any

70

Provides additional information about the institution branch.

pob_number

Any

35

Comma-separated field with the POB number of the institution/branch and the related ZIP code.
Example
"POB 103352, 40024"
This allows customers to use the full POB
address:
POB 103352
40024, DUESSELDORF (CITY).

street_address_1

Any

35

Street Name

street_address_2

Any

35

Street Number

street_address_3

Any

35

Building, building name, floor

street_address_4

Any

35

Area

city

Any

35

City name of the institution/branch

cps

Any

90

County, province, state, or other administrative region of the owner institution/branch

zip_code

Any

15

Zip code of the institution/branch

country_name

Any

70

The country name of the institution/branch as indicated in the ISO 3166

iso_country_code

Alphabetic

2

The ISO 3166-1 alpha-2 code of the country of the institution/branch

subtype_indicator

Any

4

The business type of the entity. Subtype Indicator is provided only for records with a BIC.
Subtype indicator codes are described in the table below named "Subtypes"

network_connectivity

Alphanumeric

3

Status of an entity's connection to SWIFT.
Network connectivity is provided only for records containing a BIC.

Status of an entity's connection to the following:
• FIN
• InterAct
• FileAct
Values:
• [C] Connected
• [N] Not connected
Example
For an institution connected to FIN and
FileAct but not to InterAct = CNC

service_codes

Any

60

SWIFT FIN service codes (also called value added service codes).
Service Codes are provided only for records containing a BIC.
The field can contain up to 20 three-character codes in alphabetical order.

The 'subtype_indicator' values and descriptions can be found in the table below:

Data Field: subtype_indicator

Part of 'directory_results' object.

Value

Description

MCFI

Financial Institution in a MA-CUG

SUPE

SWIFT Member/Sub member

Brokers-Dealers

Co-operative Agreement with SWIFT

Central Depositories

Clearing Houses

Fiduciary Service Companies

Fund Administrators

Investment Management Institutions

Money Brokers

Non-Shareholding Financial Institutions

Recognised Exchanges

Registrars and Transfer Agents

Trading Institutions and Trustees

Subsidiary Providers of Custodian and Nominee Services

NOSU

Electronic Trade Confirmation Providers

Securities Proxy Voting Agency

Travellers' Cheques Issuers

NSWB

Non-connected BICs

PSPA

Payment System Participants

SSPA

Securities System Participants

SWIF

Undefined Institutions

CRES

CREST participants

DOMS

SWIFT internal subtype to qualify the domestic customers for AU-NPP and the JV India

PASO

Partners

PRFI

Non-SWIFT users

Non-financial and corporate entities

BEID

Business Entity Identifier

COOP

Cooperation Agreement: a special agreement with SWIFT for the use of SWIFT messaging services

CORP

Corporate

MCCO

Non-Financial Institution Participant in a MA-CUG

NOSU

Treasury ETC Service Provider

SMDP

Securities Market Data Provider

TRCO

Treasury Counterparty

The 'service_codes' values and descriptions can be found in the table below:

Data Field: service_codes

Part of 'directory_results' object.

Country code

Country name

Market infrastructure service name

Service code

TARGET2 DIRECT PARTICIPANTS

TGT

TARGET2 INDIRECT PARTICIPANTS and addressable BICs

TG+

EBA CLEARING - EURO1

EBA

EBA CLEARING - EURO1/STEP1 REACHABLE INSTITUTIONS

EB+

EBA CLEARING - EURO1/STEP1 (EBA)

ABE

EBA CLEARING - STEP1

ERP

BH

BAHRAIN

BAHRAIN SSS (SECURITIES SETTLEMENT SYSTEM)

CBS

US

UNITED STATES OF AMERICA

Omgeo (INTELLIGENT TRADE MANAGEMENT SOLUTIONS)

OMG

ZA

SOUTH AFRICA

STRATE - SHARE TRANSACTIONS TOTALLY ELECTRONIC

ZAS

SCORE FIN

SCO

Financial institution restricted to a Member-Administered Closed User Group (MA-CUG)

MAC

Other Payment Clearing Systems Service Codes

AE

UNITED ARAB EMIRATES

RAPID-FINCOPY RPD (LIVE)

RPD

AL

ALBANIA

ALBANIAN INTERBANK PAYMENT SYSTEM

AIP

AO

ANGOLA

SISTEMA DE LIQUIDACO POR BRUTO

PTR

AU

AUSTRALIA

PAYMENT DELIVERY SYSTEM/RITS-RTGS

PDS

AU

AUSTRALIA

AUSTRACLEAR CLOSED USER GROUP

ACL

AT

AUSTRIA

CCP.CEE

CCE

AT

AUSTRIA

BULK PAYMENTS BYCLEARING SERVICE AUSTRIA

CSA

AT

AUSTRIA

OEK CSD

OEK

AZ

AZERBAIJAN

AZIPS - AZERBAIJAN INTERBANK PAYMENT SYSTEM

AZM

BA

BOSNIA AND HERZEGOVINA

BOSNIA I HERCEGOVINA RTGS

BAP

BB

BARBADOS

CBRTGS - CENTRAL REAL TIME GROSS SETTLEMENT SYSTEM

BDS

BH

BAHRAIN

BAHRAIN RTGS

BHR

BI

BURUNDI

BURUNDI RTGS SYSTEM FOR EAPS

BPS

BS

BAHAMAS

BAHAMAS RTGS

BHS

BW

BOTSWANA

BOTSWANA INTERBANK SETTLEMENT SYSTEM

BIS

CA

CANADA

LVTS - LARGE VALUE TRANSFER SYSTEM

CAD

CA

CANADA

MT566 - CORPORATE ACTION CONFIRMATION DELIVERY SERVICE

CDS

CD

CONGO, THE DEMOCRATIC REPUBLIC OF THE

CSD SERVICE OF DRC

BCG

CD

CONGO, THE DEMOCRATIC REPUBLIC OF THE

RTGS OF CENTRAL BANK OF CONGO

CBC

CH

SWITZERLAND

SWISS INTERBANK CLEARING (SIC)

PCH

CH

SWITZERLAND

UBS THIRD PARTY FIN MT971

UTP

CL

CHILE

SISTEMA CHILENO DE PAGOS INTERBANCARIOS

SCP

CM

CAMEROON

SYGMA

SYG

CO

COLOMBIA

COMPENSACION DE DIVISAS DE COLOMBIA

CCC

CZ

CZECHIA

CSD PRAGUE FIN-CUG

UNI

DE

GERMANY

EPM-ECB

EP+

DK

DENMARK

KRONOS - DANISH KRONE RTGS

DD+

DK

DENMARK

KRONOS - DANISH KRONE RTGS

DDK

DK

DENMARK

DANMARKS NATIONAL BANK

DKD

DK

DENMARK

VP SECURITIES A/S CUG

VPD

DO

DOMINICAN REPUBLIC

SIPARD LBTR

SDD

DZ

ALGERIA

BANK OF ALGERIA - GROSS PAYMENT SYSTEM

ALG

EG

EGYPT

MCDR_FIN_CUG

MCS

EG

EGYPT

PAYMENT SYSTEM IN EGYPT

PEG

ES

SPAIN

REGIS-TR CORPORATE STATUS

RTC

ES

SPAIN

SPI

CAM

FJ

FIJI

RTGS FIJI

FBN

GB

UNITED KINGDOM

BLACKROCK

BFI

GB

UNITED KINGDOM

BLOOMBERG ASSET AND INVESTMENT MANAGER

AIM

GB

UNITED KINGDOM

BLOOMBERG CORPORATE TREASURY MANAGEMENT

TRM

GB

UNITED KINGDOM

BLOOMBERG MONEY MARKET FUNDS

BMF

GB

UNITED KINGDOM

BLOOMBERG FX SETTLEMENT SERVICE

FXG

GB

UNITED KINGDOM

BLOOMBERG SELL SIDE TRADE ORDER MANAGEMENT SOLUTIONS

TOM

GB

UNITED KINGDOM

BLOOMBERG SELL SIDE EXECUTION AND ORDER MANAGEMENT SOLUTIONS

SSE

GB

UNITED KINGDOM

BLOOMBERG STRAIGHT THROUGH PROCESSING

STP

GB

UNITED KINGDOM

BROADRIDGE MATCHING

CCS

GB

UNITED KINGDOM

GSTP GLOBAL STRAIGHT THROUGH PROCESSING

GST

GB

UNITED KINGDOM

CHAPS STERLING (RTGS)

STG

GB

UNITED KINGDOM

LCH - TRADE LEG FEED

TLF

GB

UNITED KINGDOM

SWIFTNET BULK PAYMENTS BY VOCALINK

GSS

GH

GHANA

GHANA INTERBANK SETTLEMENT SYSTEM (GISS)

GIS

GM

GAMBIA

GAMBIA RTGS

CBG

GN

GUINEA

REPUBLIQUE DE GUINEE RTGS SERVICE

GNR

HK

HONG KONG

HONG KONG RTGS SERVICE

HKL

HN

HONDURAS

LBTR HONDURAS - FIN COPY (LIVE)

SPH

HR

CROATIA

HSVP - HRVATSKI SUSTAV VELIKIH PLACANJA

HRK

HU

HUNGARY

CLOSED USER GROUP FOR HUNGARIAN SECURITIES MARKET

KLR

HU

HUNGARY

VIBER - VALOS IDEJU BRUTTO ELSZAMOLASI RENDSZER

HUF

IL

ISRAEL

ISRAELI RTGS

BIR

IL

ISRAEL

ISRAEL: TAC - TACH CUG (LIVE)

TAC

IN

INDIA

XBOMINBB_CUG

XBC

IR

IRELAND

IRIS

CBI

IS

ICELAND

ICELAND RTGS SERVICE

ISG

JO

JORDAN

RTGS-JO

JOD

JO

JORDAN

JORDAN CROSS BORDER REPORTING

JOE

JO

JORDAN

JORDAN CROSS BORDER REPORTING

JOF

KE

KENYA

KENYA ELECTRONIC PAYMENT SETTLEMENT SYSTEM (KEPSS)

KPS

KN

SAINT KITTS AND NEVIS

EASTERN CARIBBEAN PAYMENTS SYSTEM

CBE

LK

SRI LANKA

LANKASETTLE

LKB

LR

LIBERIA

LIBERIA RTGS SERVICE

LRR

LS

LESOTHO

LESOTHO WIRE

LSW

LV

LATVIA

LATVIA'S ACCESS TO TARGET

LA+

LV

LATVIA

STARPBANKU AUTOMATIZETA MAKSAJUMU SISTEMA

LVL

MU

MAURITIUS

MACSS - MAURITIUS AUTOMATED CLEARING AND SETTLEMENT SYSTEM

MUP

MW

MALAWI

MALAWI: RTGS SERVICE - MITASS

RBM

MY

MALAISIA

MALAYSIA: BANK NEGARA MALAYSIA - RENTAS

RTS

NA

NAMIBIA

NAMIBIAN INTERBANK SETTLEMENT SYSTEM (NISS)

NAM

NL

THE NETHERLANDS

INTERPAY CUG

INC

NL

THE NETHERLANDS

MCF - EMCF CUG

MCF

NO

NORWAY

NORGES BANK RTGS SERVICE

NBO

NO

NORWAY

NICS - NORWEGIAN INTERBANK CLEARING SYSTEM

NOC

NO

NORWAY

OSC EQUITY CLEARING

OSC

NZ

NEW ZEALAND

AVP - ASSURED VALUE PAYMENTS

AVP

NZ

NEW ZEALAND

NZClear Interface

NSI

NZ

NEW ZEALAND

RESERVE BANK OF NEW ZEALAND - AVT

AVT

PH

PHILIPPINES

PPS - PHILIPPINES PAYMENT SYSTEM

BSP

PL

POLAND

POLAND: KDPW_FIN_CSD

KDP

PL

POLAND

POLAND: SORBNET2 - POLAND RTGS

PLN

PS

PALESTINE, STATE OF

PMA RTGS

PMA

PY

PARAGUAY

SISTEMA DE PAGOS DEL PARAGUAY

PPY

RO

ROMANIA

CSDA_FIN_CUG

DEC

RO

ROMANIA

NEW REGIS SERVICE - RON

RON

RO

ROMANIA

REPORT - ROMANIAN ELECTRONIC PAYMENT OPERATIONS IN REAL-TIME

ROL

RO

ROMANIA

ROMANIAN GSRS

ROS

RO

ROMANIA

ROMANIAN GSRS (NEW)

ROB

RW

RWANDA

RWANDAN RTGS SYSTEM FOR EAPS

RWS

SA

SAUDI ARABIA

SARIE - SAUDI ARABIAN RIYAL INTERBANK EXPRESS

SAR

SE

SWEDEN

BGC CLEARING CUG

BCC

SE

SWEDEN

RIX

SE+

SE

SWEDEN

RIX - REAL-TIME GROSS SETTLEMENT IN SEK

SSK

SE

SWEDEN

RX

SEC

SG

SINGAPORE

MEPS+ : SINGAPORE RTGS SYSTEM

MEP

SG

SINGAPORE

TEST SINGAPORE RTGS SYSTEM

MEQ

SG

SINGAPORE

TEST SERVICE FOR MEPS (INTERNAL TESTING)

MEU

SL

SIERRA LEONE

SIERRA LEONE RTGS SERVICE

SLF

SL

SIERRA LEONE

SIERRA LEONE RTGS SERVICE SLISS

SLR

SN

SENEGAL

STAR - UEMO A MI-CUG

BCA

SZ

SWAZILAND

SWAZILAND INTERBANK PAYMENTS AND SETTLEMENTS SYSTEM

IPS

TG

TOGO

ECOBANK RAPID TRADE (USD)

ERS

TG

TOGO

ECOBANK RAPID TRADE (EUR)

ERU

TH

THAILAND

BAHTBNET/2 - THAILAND PAYMENT SYSTEM

THB

TR

TURKEY

TAKASBANK DVP SETTLEMENT SYSTEM

DVP

TT

TRINIDAD AND TOBAGO

SAFE-TT

TTD

TW

TAIWAN

FOREIGN CURRENCY RTGS SERVICE

TWP

TW

TAIWAN

TAIWAN FOREIGN CURRENCY DIRECT DEBIT SERVICE

TWI

TZ

TANZANIA, UNITED REPUBLIC OF

TANZANIA INTERBANK SETTLEMENT SYSTEM (TISS)

TIS

UG

UGANDA

UGANDA NATIONAL INTER-BANK SETTLEMENT (UNIS) SYSTEM

UIS

UY

URUGUAY

FIN COPY FOR THE CENTRAL BANK OF URUGUAY

CUY

US

UNITED STATES OF AMERICA

CLN - CLSNET FINCOPY SIT/PERF

CLN

US

UNITED STATES OF AMERICA

FUNDPLICITY SERVICE

BTC

US

UNITED STATES OF AMERICA

LOAN/SERV CLEAR FIN

COT

US

UNITED STATES OF AMERICA

PERES OPERATIONS (LIVE)

PEF

VE

VENEZUELA (BOLIVARIAN REPUBLIC OF)

PVE - PAYMENTS SYSTEM VENEZUELA

PVE

VE

VENEZUELA (BOLIVARIAN REPUBLIC OF)

LBTR VENEZUELA

YVE

ZA

SOUTH AFRICA

SIRESS FIN COPY SERVICE

SRS

ZA

SOUTH AFRICA

BANKSERVAFRICA RCH

RCH

ZA

SOUTH AFRICA

SAMOS - SOUTH AFRICAN MULTIPLE OPTION SETTLEMENT

MOS

ZA

SOUTH AFRICA

SOUTH AFRICA FX FIN COPY

ZCL

ZA

SOUTH AFRICA

SOUTH AFRICAN VALUE ADDED PAYMENTS SYSTEM

ZVA

ZA

SOUTH AFRICA

SOUTH AFRICA DS FIN COPY

ZDS

ZM

ZAMBIA

ZAMBIA INTERBANK PAYMENT & SETTLEMENT SYSTEM (ZIPSS)

ZIS

ZW

ZIMBABWE

ZETSS - ZIMBABWE ELECTRONIC TRANSFER AND SETTLEMENT SYSTEM

ZET

ZW

ZIMBABWE

COMESA REPSS PAYMENT SYSTEM

CCH

5. Supported Countries

The table below provides a quick reference of the countries which the Bank Suite service covers.
Some additional information such as the local bank code name, acronym and length are also provided for your reference.