IBANIsValid
Validates a BIC and IBAN code
To connect to this service you'll need to use one of these endpoints:
Description
Checks if a BIC is a valid UK or Ireland BIC code, and retrieve additional information about the associated bank.
If an IBAN is also specified, checks if it is a potentially valid IBAN for that BIC.
Parameters
The following parameters can be supplied to this method
username |
username apikey- , e.g.
apikey-ABCD-1234-EFGH-5678
|
---|---|
password |
password |
bic | bic The BIC to validate. |
iban | iban If specified, indicates the IBAN to validate along with the |
Results
This method returns an object containing the following fields:
Status |
Status Success field is true , the other results described below can be used to get the results of the method.
If Success is false , some error occurred in calling the method, such as the authentication failed or the
account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored
|
---|---|
Valid | Valid Indicates if the supplied details are valid. This can be one of the following values:
|
SortCode | SortCode Returns the sort code in a standardised format with dashes |
AccountNumber | AccountNumber The account number in a standardised format |
BICCode | BICCode The BIC code for the bank for this branch to be used with international payments |
IBAN | IBAN The IBAN number for this account to be used with international payments |
BranchName | BranchName The name of the bank branch. For most high-street banks, this will be the town name the branch is located in. |
ShortBankName | ShortBankName The normal accepted name of the bank |
FullBankName | FullBankName The full official name of the bank |
Address | Address The postal address of the branch. Note that this may not be the same as the physical location of the branch as many banks centralise all their operations |
AcceptsBACSPayments | AcceptsBACSPayments Indicates if the account can receive payments through the BACS network |
AcceptsDirectDebitTransactions | AcceptsDirectDebitTransactions Indicates if the account can be used to take Direct Debit payments |
AcceptsDirectCreditTransactions | AcceptsDirectCreditTransactions Indicates if the account can be used to take Direct Credit payments |
AcceptsUnpaidChequeClaimTransactions | AcceptsUnpaidChequeClaimTransactions Indicates if the bank can process claims for unpaid cheques |
AcceptsBuildingSocietyCreditTransactions | AcceptsBuildingSocietyCreditTransactions Indicates if the account can be used to take credits from building societies |
AcceptsDividendInterestPaymentTransactions | AcceptsDividendInterestPaymentTransactions Indicates if the account can be used to take credits from dividend payments |
AcceptsDirectDebitInstructionTransactions | AcceptsDirectDebitInstructionTransactions Indicates if the bank can process direct debit instructions |
AcceptsCHAPSPayments | AcceptsCHAPSPayments Indicates if the account can receive payments through the CHAPS network |
AcceptsCheques | AcceptsCheques Indicates if the account can receive payments by cheque |
AcceptsFasterPayments | AcceptsFasterPayments Indicates if the account can receive payments through the Faster Payments network |