IBAN Validator
Name: dgt_ValidateIban
Validates and format the provided IBAN
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
Iban | String | ✅ | input IBAN |
AllowedCountries | StringArray | only allow IBANs from these ISO 3166-1 alpha-2 country codes | |
RejectedCountries | StringArray | do not allow IBANs from these ISO 3166-1 alpha-2 country codes |
Response Properties
Name | Type | Description |
---|---|---|
IsValid | Boolean | indicates whether the IBAN is valid |
ErrorCode | String | error code indicating the type validation error (see table below for possible error codes) |
Message | String | human readable message specifying possible validation errors |
EletronicFormat | String | machine readable format of the provided IBAN (no spaces) |
PrintFormat | String | human readable format of the provided IBAN (with spaces) |
Error Codes
Code | Description |
---|---|
CountryNotAcceptedResult | IBAN passes validation but is rejected based on AllowedCountries or RejectedCountries |
IllegalCharactersResult | IBAN contains illegal characters |
InvalidCheckDigitsResult | IBAN check digits are incorrect |
InvalidLengthResult | IBAN has an incorrect length |
InvalidStructureResult | the structure of the IBAN is incorrect |
UnknownCountryCodeResult | country code is unknown or unsupported |
IllegalCountryCodeCharactersResult | IBAN contains illegal characters in the country code |
Examples
Request
Response