BankValidation

Returns IBAN/BBAN structure for a country

Returns the IBAN length and BBAN structure for a given ISO 3166-1 alpha-2 country code.

get/v1/banks/iban-structure

Request

  • Base URL: https://api.cloud.precisely.com
  • URL: https://api.cloud.precisely.com/v1/banks/iban-structure
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

countryIso2string required

ISO 3166-1 alpha-2 country code

Headers

X-Request-Idstring

The X-Request-Id header is optional but incredibly useful for developers. It serves as a unique identifier for requests within our system. When you encounter any problems with your requests, providing us with the X-Request-Id will enable us to pinpoint the specific request in question without the need for extensive manual searching. This means faster and more efficient troubleshooting. The maximum allowed length is 38 characters.

Response

IBAN structure retrieved successfully

Example response

{
  "response": {
    "status": "OK",
    "result": {
      "countryIso2": "GB",
      "ibanLength": 22,
      "bbanStructure": [
        {
          "partType": "bank_code",
          "length": 4,
          "characterType": "n"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.