Validating a Bank Code and Account Number

To validate a bank code and account number, 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 with an account number then just complete the country code, bank code, bank code field in the call. We’ll respond with details of the bank branch.

For example to validate the the UK bank code 309408 and the account number 01638696, the details we require are

Country Code: GB

National Id: 309408

Account Number: 01638696

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

What do the optional fields do in the request

These fields are the core fields that you will use.  For the request listed above you only need complete the countryCode and nationalId fields.  We have a number of optional fields which you can use to tailor the output and are listed below.

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
errorComment E or S, if the field is set to E then you will be able to

edit the error text in the self service hub

E or S Optional N
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

Making the account number mandatory

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.

Example Output

The recommended fields Tell you what we believe you should be using

Comment and status fields give you the error text and type

Any details on the branch are held within the branch details section.
“countryCode”: “GB”,
“nationalId”: “309408”,
“accountNumber”: “01638696”,
“recommendedNatId”: “”,
“recommendedAcct”: “GB50LOYD30940801638696”,
“recommendedBIC”: “LOYDGB21124”,
“status”: “PASS”,
“comment”: “The BIC is not connected to the SWIFT network; please enter a BIC without a 1 as the 8th digit. For example LOYDGB21124 is not connected and LOYDGB2LXXX is needed (05ro)”,
“ref”: “20181026131125196”,
“group”: “”,
“branchDetails”: null,
“headOfficeDetails”: {
“bankName”: “LLOYDS BANK PLC”,
“branch”: “(U.K. INTERNATIONAL SERVICES)”,
“street”: “11-15 MONUMENT STREET”,
“city”: “LONDON”,
“postZip”: “EC3R8EN”,
“region”: “”,
“country”: “UNITED KINGDOM”,
“codeDetails”: {
“codeName1”: “BIC”,
“codeValue1”: “LOYDGB2LXXX”,
“codeName2”: “CHIPS”,
“codeValue2”: “002100”,
“codeName3”: “BIC-4”,
“codeValue3”: “LOYD”,
“codeName4”: “Sort Code”,
“codeValue4”: “309634”
},
“additionalData”: {
“ssiAvailable”: “Y”,
“payServiceAvailable”: “Y”,
“contactsAvailable”: “Y”,
“messageAvailable”: “N”,
“holidayAvailable”: “Y”
}
},
“paymentBicDetails”: {
“branchTypeLabel”: “IBAN BIC Branch”,
“bankName”: “LLOYDS BANK PLC”,
“branch”: “(HEMEL HEMPSTEAD MARLOWES -309408)”,
“street”: “198-200 MARLOWES”,
“city”: “HEMEL HEMPSTEAD”,
“postZip”: “HP11BH”,
“region”: “”,
“country”: “UNITED KINGDOM”,
“codeDetails”: {
“codeName1”: “BIC”,
“codeValue1”: “LOYDGB21124”,
“codeName2”: “CHIPS”,
“codeValue2”: “”,
“codeName3”: “BIC-4”,
“codeValue3”: “LOYD”,
“codeName4”: “Sort Code”,
“codeValue4”: “309408”
},
“additionalData”: {
“ssiAvailable”: “Y”,
“payServiceAvailable”: “Y”,
“contactsAvailable”: “Y”,
“messageAvailable”: “N”,
“holidayAvailable”: “Y”
}
},
“bic8”: “N”,
“dataStore”: “N”,
“noBranch”: “Y”,
“isoAddr”: “N”,
“payBranchType”: “D”,
“freeToken”: “HmZEist2Byw1lIOipGynEFSNv4tfaRPyoHzm0NhOnJByEMVyZcMDlyGAieie”
}