The call will check the input details you submit (country code, bank code, account number, IBAN, BBAN) against the data as registered at connected banks, and respond with a status of:
- PASS
- CAUTION
- FAIL, which helps to prevent fraud and mistakes in payments.
Furthermore, using the inbuilt intelligence, the call is very flexible and will always respond with a recommendation for the format of bank code and account number that you need to make the payment.
This call allows our clients to validate all formats of codes and account numbers and we will respond with details of the bank branch.
- If you are just validating a bank code or a BIC, then just complete the Country Code and Bank Code field in the call.
- If you are just validating a bank code or a BIC with an account number, then just complete the Country Code, Bank Code, Account Number field in the call.
- If you are just validating an IBAN or structured account number, then just complete the country code and the account number field in the call.
To prevent call from failing, you need to add either nationalId or accountNumber. Should you leave both fields empty, the call will fail with the following message: “Check data entered – Missing Search Parameters (07sy)”
Field Name | Description | Format | Mandatory or Optional |
countryCode | ISO Country Code | Alpha | Mandatory |
nationalId | Domestic bank ID or BIC | Alphanumeric | Optional |
accountNumber | Domestic Account Number, BBAN or IBAN | Alphanumeric | Optional |
Token | Security token | Alphanumeric & Extended Characters | Mandatory |
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 |
bic8 | Input “Y” if you wish any head office with xxx to be returned as a BIC8. Input “N” or leave blank if you want all BICs returned as BIC11 | Y/N | Optional | N |
noBranch | Input “N” if you do not wish to return the branch details. Input “Y” or leave blank to return branch details. | Y/N | Optional | Y |
iso20022 | Input “Y” if you wish the response to return Legal Entity Identifier data and bank addresses to be returned in both ISO 20022 structured format and non-ISO 20022 format. | Y/N | Optional | N |
payBranchType | This allows you to choose the branch type from either | I (IBAN)/ B (Branch)/ (R) Routing BIC, (P) Payment Branch, (D) Default Payment Branch | Optional | D |
sepaAll | Input “Y” to show additional field for Branch Sepa – ictStatus | Y/N | Optional | N |
page | This requests the page number you are after, the default for this is 1 | 1 | Optional | 1 |
pageSize | This defines the number of branches on a page, the default is 10 | 10 | Optional | 10 |
errorComment | Input “E” to be able to edit the error text in the self-service hub. | E or S | Optional |
- ISO20022 Structured Address will return right below all otherwise structures address, if the ISO20022 flag is enabled in the response input.
- ISO 20022 structured data is only available in New API, not Legacy API.
Field Name | Description | Format |
countryCode | ISO Country Code | Alpha |
nationalId | Domestic bank ID or BIC | Alphanumeric |
accountNumber | Domestic Account Number, BBAN or IBAN | Alphanumeric |
Status | Status of the response PASS, CAUTION or FAIL | Alpha |
comment | Description of the status | Alphanumeric |
recommendedNatId | Our recommended national id | Alphanumeric |
recommendedAcct | Our recommended account number | Alphanumeric |
recommendedBIC | Our recommended BIC | Alphanumeric |
legalEntityIdentifier | ||
identifierType | Description of the identifier type system | Alpha |
identifierValue | Value of the identifier assigned by the identifier type | |
Branch details | ||
bankName | Bank Name | Alpha |
Branch | Branch Name | Alphanumeric |
street | Address | Alphanumeric |
city | City | Alpha |
postZip | Post or Zip Code | Alphanumeric |
region | State or County | Alpha |
country | Country name | Alpha |
codeDetails | ||
codeName1 | SWIFT BIC field | Alpha |
codeValue1 | SWIFT BIC for the branch | Alphanumeric |
codeName2 | CHIPS field | Alpha |
codeValue2 | CHIPS code for the branch | Alpha? |
codeName3 | SWIFT BIC 4 field | Alphanumeric |
codeValue3 | 4 digit SWIFT BIC for the branch | Alpha? |
codeName4 | Name of the domestic Clearing Code | Alphanumeric |
codeValue4 | Domestic Clearing Code | Alphanumeric |
iso20022StructuredAddress | ||
bankName | Bank Name | Alphanumeric |
branch | Branch Name | |
addressTypeCD | ||
addressTypePrtryID | Type proprietary identifier | Alpha |
addressTypePrtryIssuer | ||
addressTypePrtrySchemeName | Schema name of proprietary identifier | Alpha |
department | Department name | Alphanumeric |
subDepartment | Sub-department name | Alphanumeric |
streetName | Name of street | Alphanumeric |
buildingNumber | Building number | Alphanumeric |
buildingName | Name of building | Alphanumeric |
floor | Floor number | Numeric |
postBox | Post box number | Alphanumeric |
room | Room number | Alphanumeric |
postCode | Postal code | Alphanumeric |
townName | Town or city name | Alpha |
townLocationName | Location name within town or city | Alpha |
districtName | District name | Alpha |
countrySubdivision | Subdivision of country (state, province, etc.) | Alpha |
iso2 | ||
addressLine1 | Address line 1 | Alphanumeric |
addressLine2 | Address line 2 | Alphanumeric |
addressLine3 | Address line 3 | Alphanumeric |
addressLine4 | Address line 4 | Alphanumeric |
addressLine5 | Address line 5 | Alphanumeric |
addressLine6 | Address line 6 | Alphanumeric |
addressLine7 | Address line 7 | Alphanumeric |
sepaDetails | ||
ctStatus | Is the bank SEPA credit transfer compliant | Y or N |
ddStatus | Is the bank SEPA direct debit compliant | Y or N |
bbStatus | Is the bank SEPA B2B direct debit compliant | Y or N |
additionalData | ||
ssiAvailable | Do we have correspondent details available | Y or N |
payServiceAvailable | Do we have domestic clearing information available | Y or N |
contactsAvailable | Do we have contact details available | Y or N |
messageAvailable | Do we have payment message details available | Y or N |
holidayAvailable | Do we have holiday details available | Y or N |
bankToken | This can be used in conjunction with the free token to retrieve additional details on this branch | Alphanumeric & Extended Characters |
sanctionsDetails | ||
euSanctions | Sanctions by EU | Y or N |
hmtSanctions | Sanctions by HM | Y or N |
ofacSanctions | Sanctions by OFAC | Y or N |
unSanctions | Sanctions by UN | Y or N |
head office details | ||
bankName | Bank Name | Alpha |
Branch | Branch Name | Alphanumeric |
street | Address | Alphanumeric |
city | City | Alpha |
postZip | Post or Zip Code | Alphanumeric |
region | State or County | Alpha |
country | Country name | Alpha |
codeDetails | ||
codeName1 | SWIFT BIC field | Alpha |
codeValue1 | SWIFT BIC for the branch | Alphanumeric |
codeName2 | CHIPS field | Alpha |
codeValue2 | CHIPS code for the branch | Alpha? |
codeName3 | SWIFT BIC 4 field | Alphanumeric |
codeValue3 | 4 digit SWIFT BIC for the branch | Alpha? |
codeName4 | Name of the domestic Clearing Code | Alphanumeric |
codeValue4 | Domestic Clearing Code | Alphanumeric |
iso20022StructuredAddress | ||
bankName | Bank Name | Alphanumeric |
branch | Branch Name | |
addressTypeCD | ||
addressTypePrtryID | Type proprietary identifier | Alpha |
addressTypePrtryIssuer | ||
addressTypePrtrySchemeName | Schema name of proprietary identifier | Alpha |
department | Department name | Alphanumeric |
subDepartment | Sub-department name | Alphanumeric |
streetName | Name of street | Alphanumeric |
buildingNumber | Building number | Alphanumeric |
buildingName | Name of building | Alphanumeric |
floor | Floor number | Numeric |
postBox | Post box number | Alphanumeric |
room | Room number | Alphanumeric |
postCode | Postal code | Alphanumeric |
townName | Town or city name | Alpha |
townLocationName | Location name within town or city | Alpha |
districtName | District name | Alpha |
countrySubdivision | Subdivision of country (state, province, etc.) | Alpha |
iso2 | ||
addressLine1 | Address line 1 | Alphanumeric |
addressLine2 | Address line 2 | Alphanumeric |
addressLine3 | Address line 3 | Alphanumeric |
addressLine4 | Address line 4 | Alphanumeric |
addressLine5 | Address line 5 | Alphanumeric |
addressLine6 | Address line 6 | Alphanumeric |
addressLine7 | Address line 7 | Alphanumeric |
additionalData | ||
ssiAvailable | Do we have correspondent details available | Y or N |
payServiceAvailable | Do we have domestic clearing information available | Y or N |
contactsAvailable | Do we have contact details available | Y or N |
messageAvailable | Do we have payment message details available | Y or N |
holidayAvailable | Do we have holiday details available | Y or N |
bankToken | This can be used in conjunction with the free token to retrieve additional details on this branch | Alphanumeric & Extended Characters |
sanctionsDetails | ||
euSanctions | Sanctions by EU | Y or N |
hmtSanctions | Sanctions by HM | Y or N |
ofacSanctions | Sanctions by OFAC | Y or N |
unSanctions | Sanctions by UN | Y or N |
paymentBicDetails | ||
branchTypeLabel | Branch Type | Alpha |
bankName | Bank Name | Alpha |
Branch | Branch Name | Alphanumeric |
street | Address | Alphanumeric |
city | City | Alpha |
postZip | Post or Zip Code | Alphanumeric |
region | State or County | Alpha |
country | Country name | Alpha |
codeDetails | ||
codeName1 | SWIFT BIC field | Alpha |
codeValue1 | SWIFT BIC for the branch | Alphanumeric |
codeName2 | CHIPS field | Alpha |
codeValue2 | CHIPS code for the branch | Alpha? |
codeName3 | SWIFT BIC 4 field | Alphanumeric |
codeValue3 | 4 digit SWIFT BIC for the branch | Alpha? |
codeName4 | Name of the domestic Clearing Code | Alphanumeric |
codeValue4 | Domestic Clearing Code | Alphanumeric |
iso20022StructuredAddress | ||
bankName | Bank Name | Alphanumeric |
branch | Branch Name | |
addressTypeCD | ||
addressTypePrtryID | Type proprietary identifier | Alpha |
addressTypePrtryIssuer | ||
addressTypePrtrySchemeName | Schema name of proprietary identifier | Alpha |
department | Department name | Alphanumeric |
subDepartment | Sub-department name | Alphanumeric |
streetName | Name of street | Alphanumeric |
buildingNumber | Building number | Alphanumeric |
buildingName | Name of building | Alphanumeric |
floor | Floor number | Numeric |
postBox | Post box number | Alphanumeric |
room | Room number | Alphanumeric |
postCode | Postal code | Alphanumeric |
townName | Town or city name | Alpha |
townLocationName | Location name within town or city | Alpha |
districtName | District name | Alpha |
countrySubdivision | Subdivision of country (state, province, etc.) | Alpha |
iso2 | ||
addressLine1 | Address line 1 | Alphanumeric |
addressLine2 | Address line 2 | Alphanumeric |
addressLine3 | Address line 3 | Alphanumeric |
addressLine4 | Address line 4 | Alphanumeric |
addressLine5 | Address line 5 | Alphanumeric |
addressLine6 | Address line 6 | Alphanumeric |
addressLine7 | Address line 7 | Alphanumeric |
additionalData | ||
ssiAvailable | Do we have correspondent details available | Y or N |
payServiceAvailable | Do we have domestic clearing information available | Y or N |
contactsAvailable | Do we have contact details available | Y or N |
messageAvailable | Do we have payment message details available | Y or N |
holidayAvailable | Do we have holiday details available | Y or N |
bankToken | This can be used in conjunction with the free token to retrieve additional details on this branch | Alphanumeric & Extended Characters |
sanctionsDetails | ||
euSanctions | Sanctions by EU | Y or N |
hmtSanctions | Sanctions by HM | Y or N |
ofacSanctions | Sanctions by OFAC | Y or N |
unSanctions | Sanctions by UN | Y or N |
bic8 | Did you input “Y” for head office with xxx to be returned as a BIC8, or “N” or leave blank if you wanted all BICs returned as BIC11 | Y or N |
dataStore | Unused | |
noBranch | Returns the input “N” if you did not wish to return the branch details, or “Y” or leave blank to return branch details. | Y or N |
iso20022 | Returns the input “Y” if you wished the response to return Legal Entity Identifier data and addresses to be returned in both ISO 20022 structured format and non-ISO 20022 format. | Y or N |
payBranchType | Returns what branch type you chose. | I (IBAN)/ B (Branch)/ (R) Routing BIC, (P) Payment Branch, (D) Default Payment Branch |
freeToken | Free token generated for supplementary calls. These are from the primary service calls. | Alphanumeric & Extended Characters |
To validate the BIC BARCGB22XXX, the details we require are
- Country Code: GB
- National Id: 206874
{
“countryCode”: “GB”,
“nationalId”: “206874”,
“accountNumber”: “”,
“status”: “PASS”,
“comment”: “Account number not entered (08an)”,
“recommendedNatId”: “206874”,
“recommendedAcct”: “”,
“recommendedBIC”: “BARCGB22XXX”,
“ref”: “20241105103752810”,
“group”: “”,
“legalEntityIdentifier”: {
“identifierType”: “London Stock Exchange LEI Limited (London Stock Exchange) (IEI)”,
“identifierValue”: “G5GSEF7VJP5I7OUK5573”
},
“branchDetails”: [
{
“bankName”: “Barclays Bank PLC”,
“branch”: “”,
“street”: “1 Churchill Place”,
“city”: “London”,
“postZip”: “E14 5HP”,
“region”: “England”,
“country”: “UNITED KINGDOM”,
“codeDetails”: {
“codeName1”: “BIC”,
“codeValue1”: “BARCGB22XXX”,
“codeName2”: “CHIPS”,
“codeValue2”: “313564”,
“codeName3”: “BIC-4”,
“codeValue3”: “BARC”,
“codeName4”: “Sort Code”,
“codeValue4”: “206874”
},
“iso20022StructuredAddress”: {
“bankName”: “Barclays Bank PLC”,
“branch”: “”,
“addressTypeCD”: “”,
“addressTypePrtryID”: “”,
“addressTypePrtryIssuer”: “physical”,
“addressTypePrtrySchemeName”: “”,
“department”: “”,
“subDepartment”: “”,
“streetName”: “Churchill Place”,
“buildingNumber”: “1”,
“buildingName”: “”,
“floor”: “”,
“postBox”: “”,
“room”: “”,
“postCode”: “E14 5HP”,
“townName”: “London”,
“townLocationName”: “”,
“districtName”: “Greater London”,
“countrySubdivision”: “England”,
“iso2”: “GB”,
“addressLine1”: “”,
“addressLine2”: “”,
“addressLine3”: “”,
“addressLine4”: “”,
“addressLine5”: “”,
“addressLine6”: “”,
“addressLine7”: “”
},
“sepaDetails”: {
“ctStatus”: “YES”,
“ddStatus”: “YES”,
“bbStatus”: “YES”
},
“additionalData”: {
“ssiAvailable”: “Y”,
“payServiceAvailable”: “Y”,
“contactsAvailable”: “N”,
“messageAvailable”: “Y”,
“holidayAvailable”: “Y”
},
“bankToken”: “6vQ60VLVaW3gvSkLd6zisUIxKladMYY5wQB7M5zGjIFrf6xMDmQG63Aieie”,
“sanctionsDetails”: {
“euSanctions”: “N”,
“hmtSanctions”: “N”,
“ofacSanctions”: “N”,
“unSanctions”: “N”
}
}
],
“headOfficeDetails”: {
“bankName”: “Barclays Bank PLC”,
“branch”: “”,
“street”: “1 Churchill Place”,
“city”: “London”,
“postZip”: “E14 5HP”,
“region”: “England”,
“country”: “UNITED KINGDOM”,
“codeDetails”: {
“codeName1”: “BIC”,
“codeValue1”: “BARCGB22XXX”,
“codeName2”: “CHIPS”,
“codeValue2”: “313564”,
“codeName3”: “BIC-4”,
“codeValue3”: “BARC”,
“codeName4”: “Sort Code”,
“codeValue4”: “206874”
},
“iso20022StructuredAddress”: {
“bankName”: “Barclays Bank PLC”,
“branch”: “”,
“addressTypeCD”: “”,
“addressTypePrtryID”: “”,
“addressTypePrtryIssuer”: “physical”,
“addressTypePrtrySchemeName”: “”,
“department”: “”,
“subDepartment”: “”,
“streetName”: “Churchill Place”,
“buildingNumber”: “1”,
“buildingName”: “”,
“floor”: “”,
“postBox”: “”,
“room”: “”,
“postCode”: “E14 5HP”,
“townName”: “London”,
“townLocationName”: “”,
“districtName”: “Greater London”,
“countrySubdivision”: “England”,
“iso2”: “GB”,
“addressLine1”: “”,
“addressLine2”: “”,
“addressLine3”: “”,
“addressLine4”: “”,
“addressLine5”: “”,
“addressLine6”: “”,
“addressLine7”: “”
},
“additionalData”: {
“ssiAvailable”: “Y”,
“payServiceAvailable”: “Y”,
“contactsAvailable”: “N”,
“messageAvailable”: “Y”,
“holidayAvailable”: “Y”
},
“sanctionsDetails”: {
“euSanctions”: “N”,
“hmtSanctions”: “N”,
“ofacSanctions”: “N”,
“unSanctions”: “N”
}
},
“paymentBicDetails”: {
“branchTypeLabel”: “IBAN BIC Branch”,
“bankName”: “Barclays Bank PLC”,
“branch”: “”,
“street”: “1 Churchill Place”,
“city”: “London”,
“postZip”: “E14 5HP”,
“region”: “England”,
“country”: “UNITED KINGDOM”,
“codeDetails”: {
“codeName1”: “BIC”,
“codeValue1”: “BARCGB22XXX”,
“codeName2”: “CHIPS”,
“codeValue2”: “313564”,
“codeName3”: “BIC-4”,
“codeValue3”: “BARC”,
“codeName4”: “Sort Code”,
“codeValue4”: “206874”
},
“iso20022StructuredAddress”: {
“bankName”: “Barclays Bank PLC”,
“branch”: “”,
“addressTypeCD”: “”,
“addressTypePrtryID”: “”,
“addressTypePrtryIssuer”: “physical”,
“addressTypePrtrySchemeName”: “”,
“department”: “”,
“subDepartment”: “”,
“streetName”: “Churchill Place”,
“buildingNumber”: “1”,
“buildingName”: “”,
“floor”: “”,
“postBox”: “”,
“room”: “”,
“postCode”: “E14 5HP”,
“townName”: “London”,
“townLocationName”: “”,
“districtName”: “Greater London”,
“countrySubdivision”: “England”,
“iso2”: “GB”,
“addressLine1”: “”,
“addressLine2”: “”,
“addressLine3”: “”,
“addressLine4”: “”,
“addressLine5”: “”,
“addressLine6”: “”,
“addressLine7”: “”
},
“additionalData”: {
“ssiAvailable”: “Y”,
“payServiceAvailable”: “Y”,
“contactsAvailable”: “N”,
“messageAvailable”: “Y”,
“holidayAvailable”: “Y”
},
“sanctionsDetails”: {
“euSanctions”: “N”,
“hmtSanctions”: “N”,
“ofacSanctions”: “N”,
“unSanctions”: “N”
}
},
“bic8”: “N”,
“dataStore”: “N”,
“noBranch”: “N”,
“isoAddr”: “N”,
“iso20022”: “Y”,
“payBranchType”: “D”,
“freeToken”: “pJqpisJJCRkLJcWWJR547tTgVH5kfUjfPtzZvHisXRWVisUFKDqJH9LOETRVNRDtP3a8Auxp1ZsDisUie”
}