GET /account/iban/:iban

IBAN information

Checks if a given IBAN account number is valid and returns additional information.

Path Parameters

iban string required

IBAN account number to check if valid and get additional information for.

Responses

• 200
• 401

---

IBAN information

application/json

Schema

Example (from schema)

---

Schema

iban IBAN

Possible values: >= 15 characters and <= 34 characters

IBAN account number with country prefix

status IBANStatus

Possible values: [invalid, valid]

Information if the IBAN account number is in a valid format. NOTE: A valid format doesn't necessary mean the account number is an existing account. If IBAN is invalid type and position of first encountered error is reported in IBANError field.

country CountryCode

Account information provider country code (ISO 3166 alpha-2 codes)

bankCode BankCode

IBAN bank code as defined by IBAN format

errorMessage object
Detailed information why IBAN account number is not correct.
type string
Possible values: [invalid, invalid_length, invalid_country, invalid_format, invalid_bank_code, invalid_branch_code]
message string
position integer

{
  "iban": "AT483200000012345865",
  "status": "invalid",
  "country": "AT",
  "bankCode": "48320",
  "errorMessage": {
    "type": "invalid_length",
    "message": "IBAN 'AT483200000012345865' is invalid, check digit: 48, doesn't match expected check: 21",
    "position": 3
  }
}

Unauthorized

application/json

Schema

Example (from schema)

Example

---

Schema

errorMessage string required

Description of error

errorCode ErrorCode required

Possible values: [invalid_parameter, unauthorized, forbidden, not_found, not_allowed, bad_request, other]

Error code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}

errorSubCode ErrorSubCode

Possible values: [api_key_secret_header_must_be_provided, authorization_header_must_be_provided, access_not_allowed, domain_not_allowed, access_token_expired, invalid_access_scope, not_authorized, phone_or_email_not_registered, phone_number_start_with_plus_and_country, phone_number_invalid, email_invalid, email_or_phone_number_required, invalid_pin, could_not_interpret_numbers_after_plus, supplied_string_not_phone_number, string_supplied_too_short_to_be_phone_number, string_supplied_too_long_to_be_phone_number, string_supplied_was_too_long_to_parse, unspecified]

Error sub code of a specific error. For more details visit https://documentation.fliqa.io/api/errors/{errorCode}#{errorSubCode}

documentationUrl uri

Link to documentation if available, typically https://documentation.fliqa.io/api/errors/{errorCode}

requestId RequestId

Unique request id

resourceId ResourceId

Unique resource id

{
  "errorMessage": "string",
  "errorCode": "unauthorized",
  "errorSubCode": "phone_or_email_not_registered",
  "documentationUrl": "string",
  "requestId": "554099e7d0b648d7b96bc31c148425b8",
  "resourceId": "a683072aeeb746d58aa34dd5537c4aae"
}

{
  "errorCode": "unauthorized",
  "errorMessage": "Not authorized",
  "documentationUrl": "https://documentation.fliqa.io/api/errors/unauthorized"
}

Loading...