Validating a Bank Code

To validate a bank code use call 1.01. Call 1.01 is our core call and allows our clients to validate all formats of codes and account numbers.

If you’re just validating a bank code or a BIC then just complete the country code and bank code field in the call. We’ll respond with details of the bank branch.

For example to validate the BIC CITIUS33XXX, the details we require are

Country Code: US

National Id: CITIUS33XXX

Account Number:

https://apps.applyfinancial.co.uk/validate-api/rest/convert/1.0.1?countryCode=US&nationalId=CITIUS33XXX&accountNumber=&token=entertoeknhere&noBranch=Y&errorComment=E

FIELD NAME DESCRIPTION FORMAT MANDATORY or

OPTIONAL

DEFAULT VALUE
countryCode ISO Country Code Alpha Mandatory
nationalId Domestic bank ID Alphanumeric Optional
accountNumber Domestic Account Number,

BBAN or IBAN

Alphanumeric Optional
token Security token Alphanumeric & Extended Characters Optional

The response for this request can be modified with a number of flags which allow us to give you a response which meets your business requirements.

FIELD NAME DESCRIPTION FORMAT MANDATORY or

OPTIONAL

DEFAULT VALUE
dataStore Yes/No flag if you wish the data to be stored for periodic scanning using the Y or N Optional N
ref Free text unique reference for you to use.  If this is not completed by you we will respond with a unique reference Alphanumeric & Extended Characters Optional
noBranch Yes/No flag if you do not wish to return the branch details. Y or N Optional Y
bic8 Yes/No flag if you wish any head office with xxx to be returned as a BIC8 or BIC11. Yes if you wish to have a BIC8 (without head office XXX) No or leave blank if you want all BICs returned as BIC11 Y or N Optional N
isoAddr This restricts the field size to the ISO defined 80 characters Y or N Optional N
payBranchType This allows you to choose the branch type from either

I IBAN

R Routing

P Payment

B Branch

H Head Office

I,B,H,R Optional P
group The group name that this data should be saved in.  Currently not used. Alphanumeric & Extended Characters Optional
page This requests the page number you are after, the default for this is 1 Numeric Optional 1
pageSize This defines the number of branches on a page, the default is 10 Numeric Optional 10

If you need the account number to be mandatory then please got to the self service hub using the link below.

https://apps.applyfinancial.co.uk/vss-web/apply/login

Then go to the error module in the bottom left and change the error below to FAIL

08an Account number not entered

Then save the changes and the service will set the account number as mandatory.