Sign in

v4

latestOpenAPI 3.1.02026-08-0117737.6 KB
Free

IBAN structure template for a country (free)

FREE metadata endpoint: returns the IBAN structural template for a country — total IBAN length, BBAN field positions (bank code / branch code / account number, 0-indexed within the BBAN), SEPA membership + schemes + VoP obligation, and a canonical example IBAN to copy-paste. Use it when an agent needs to know the IBAN format for a country before crafting a validation call.

get/v1/iban/structure/{country}

Path parameters

countrystring required
Example:CH

ISO 3166-1 alpha-2 country code (case-insensitive)

Response

IBAN structure template

iban_lengthinteger required
bban_lengthinteger required
bban_patternstring nullable

Full BBAN pattern in SWIFT IBAN Registry notation (e.g. "5!n12!c") — what /v1/iban/validate enforces structurally on top of length + mod-97.

example_ibanstring nullable
example_iban_notestring nullable

Says what example_iban is: an illustration from the SWIFT IBAN Registry whose bank code is not guaranteed to be allocated. 36 of the 89 come back bank_code_check.status not_in_register, which is the example being fictional rather than a gap in our data. LV uses the literal 'BANK', RO uses 'AAAA', and the Swiss one is proven unallocated by the SIX BankMaster.

notesstring
upgrade_hintstring
cost_usdcnumber required

Example response

{
  "country": {
    "code": "CH",
    "name": "Switzerland"
  },
  "iban_length": 21,
  "bban_length": 17,
  "bban_pattern": "5!n12!c",
  "example_iban": "CH9300762011623852957"
}