Getting the input data

If you are validating the IBAN, you can omit most of this flow. You only need to get the IBAN from the user. Then you call ValidateIBAN supplying the IBAN only. You do not need to supply either the checking level or the country code.

Flow showing how to get the required inputs

Call GetCountries

If you do not know the country code to use, call GetCountries. For each supported country, this returns the country code and the country name.

Save country code

You must supply the 2 character country code to most services when you call them. Therefore you should store the codes you need so that you can add them to the input data as required.

Call GetCountryInput

If you do not know which input fields and checking levels are used for a country, you can call GetCountryInput. For the specified country, this returns a list of the available checking levels and the input information required for each checking level.

You can use the GetCountries and GetCountryInput services to automatically generate a user interface. You could do this if you need to support a large number of countries or if you are likely to add countries and you want your application to be easily extended to support multiple countries.

Get checking level from user

You must specify the type of check you want to perform; account, BIC, branch or domestic. The levels available are determined by the country for which the check is being performed.

Get account details from user

The exact details the user must supply is determined by the type of check you want to perform (Account, BIC, Branch or Domestic) and the country for which the check is being performed.

If you are validating the IBAN, the account details are the IBAN.

Perform validation

To validate the account details, you call Validate, supplying the country code, checking level and relevant BBAN fields.

To validate the IBAN, call ValidateIBAN supplying the IBAN only.

Get personal and/or company details

Currently, you can only verify United Kingdom accounts.

If you are verifying the account, as well as the account details you must get:

The personal details are name, date of birth and address of the account holder

The company details are:

Optionally you can also get extra account details, such as account setup date, owner type and so on.

Perform verification

To verify the account, call Verify, supplying the country code, check context, BBAN, extra account details (if required) and personal or company details.

Next step: Call the service