Endpoint: https://api.validate.bankersalmanac.com/validation
Swagger link: https://api.validate.bankersalmanac.com/swagger-ui/index.html#/conversion-service-endpoint/validation
Overview
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.
Endpoint inputs
| Field Name | Description | Format | Mandatory or Optional | Default Value |
| 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 |
Response modifications
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 |
| 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, B Branch, R Routing BIC, P Payment Branch, D Default Payment Branch | Optional | D |
| 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 | 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 | |
| SepaAll | If the filed is set to Yes then it shows the additional field for Branch Sepa – ictStatus | Y or N | Optional | N |
Response outcomes
To understand the responses, please refer to Swagger:
| Field Name | Description | Format | Mandatory or Optional | Default value |
| dataStore | not used | |||
| 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, B Branch, R Routing BIC, P Payment Branch, D Default Payment Branch | Optional | D |
| group | not used | |||
| 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 |
| 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 | |
| SepaAll | If the filed is set to Yes then it shows the additional field for Branch Sepa – ictStatus | Y or N | Optional | N |
Test Examples
For example to validate the BIC CITIUS33XXX, the details we require are
- Country Code: US
- National Id: CITIUS33XXX