Developers

IBANValidate

1. REST

2.1 SOAP - Document Literal

2.2 SOAP - RPC

Important note.

All BankVal web services are available on both the main and backup servers at our primary data centre. This configuration is mirrored at our secondary data centre. The two data centres are geographically independent. Using this configuration, the BankVal web service has been available continuously since launch in 2003.

In general:

  • Call the service at the primary data centre at www.unifiedservices.co.uk
  • In the unlikely event of a failure, call the service at the secondary data centre at www.unifiedsoftware.co.uk

1 IBANValidate - REST


IBANValidate functionality:

  • Validates any IBAN, International Bank Account Number, to ECBS standards.

Follow these three steps:-

  • 1. Attempt to access the service on unifiedservices.co.uk
  • 2. Check the http response code
  • 3. If this is < 200 or > 399, access the backup service on unifiedsoftware.co.uk

URI for IBANValidate

  • GET https://www.unifiedservices.co.uk/services/bankvalint/ibanvalidator/userid/<userid>/pin/<pin>/iban/<iban>/<format>/
  • If http response code is < 200 or > 399 then call:-
  • GET https://www.unifiedsoftware.co.uk/services/bankvalint/ibanvalidator/userid/<userid>/pin/<pin>/iban/<iban>/<format>/

where:

  • <userid> and <pin> are your user ID and 5 digit PIN obtained upon registration at:
    www.unifiedsoftware.co.uk/free-trial/free-trial-home.html
  • <iban> is the IBAN number to be validated.
  • <format> specifies the format of the returned data. Valid formats are csv, xml and json. (csv uses the "|" delimiter)

Results

If IBAN is valid:-

  • The string VALID is returned

Example Valid Results

Sample valid response in xml format :-

<iban>

  • <result>VALID<result>

</iban>


Sample valid response in json format :-

  • {"result":"VALID"}

Sample valid response in csv format :-

  • VALID

If IBAN is not valid or if an error occurs:-

  • Return field - contains an error message

Error messages :-

Error Messages

VALID - IBAN is valid

INVALID - Country Code - The Country Code within the supplied IBAN is not valid

INVALID - Modulus Check Failed - The IBAN failed the modulus check

INVALID - Format - The supplied IBAN is not in a valid format

ERROR - Invalid User ID/PIN - The User ID or PIN has not been recognised.

ERROR - UserID Expired - Trial user ID has expired.

ERROR - Insecure connection - An attempt was made to access BankVal International's ibanvalidate service using insecure HTTP protocol instead of HTTPS.


<< Back to Top >>


2 IBANValidate - SOAP


IBANValidate functionality:

  • Validates any IBAN, International Bank Account Number, to ECBS standards.

Choose SOAP style:

There are two main ways of implementing SOAP, Document Literal and RPC. For help choosing the best solution for your implementation, please contact support@unifiedsoftware.co.uk.


2.1 IBANValidate SOAP - Document Literal

2.2 IBANValidate SOAP - RPC


<< Back to Top >>


2.1 IBANValidate - SOAP Document Literal


IBAN Validate functionality:

  • Validates any IBAN, International Bank Account Number, to ECBS standards.

WSDL files

The WSDL file on the primary data centre is at https://www.unifiedservices.co.uk/services/bankvalint/ibanvalidate.php?wsdl

The WSDL file on the backup data centre is at https://www.unifiedsoftware.co.uk/services/bankvalint/ibanvalidate.php?wsdl


Request

Parameters

Description

userid

BankVal User ID.

pin

5 digit PIN.

iban

International Bank Account Number.

Response

Field

Description

result

Result string contains on of the following messages:-
VALID - IBAN is valid.
INVALID - Modulus Check Failed - The IBAN did not pass the modulus check validation test.
INVALID - Country Code - The Country Code was not a valid IBAN country code.
INVALID - Format - The IBAN was not in the correct format for the specified country.
ERROR - Invalid User ID/PIN - The User ID or PIN has not been recognised.
ERROR - UserID Expired - Trial user ID has expired.
ERROR - Insecure Connection - An attempt was made to access BankVal's ibanvalidate method using insecure HTTP protocol instead of HTTPS.


<< Back to Top >>


2.2 IBANValidate - SOAP RPC


IBANValidate functionality:

  • Validates any IBAN, International Bank Account Number, to ECBS standards.

Parameter Format for IBANValidate

ReturnMessage = ibanvalidate(QueryString)

where

QueryString is a " | " delimited string of the format "userID|PIN|IBAN"

All possible ReturnMessage values are shown below

ReturnMessage meanings

VALID - IBAN is valid

INVALID - Country Code - The Country Code within the supplied IBAN is not valid

INVALID - Modulus Check Failed - The IBAN failed the modulus check

INVALID - Format - The supplied IBAN is not in a valid format

ERROR - Invalid User ID/PIN - The User ID or PIN has not been recognised.

ERROR - UserID Expired - Trial user ID has expired.

ERROR - Insecure connection - An attempt was made to access BankVal International's ibanvalidate service using insecure HTTP protocol instead of HTTPS.


WSDL files

The WSDL file on the primary data centre is at https://www.unifiedsoftware.co.uk/BankValinternationalall.wsdl

The WSDL file on the backup data centre is at https://www.unifiedservices.co.uk/BankValinternationalall.wsdl


<< Back to Top >>