Content can be downloaded with GET method.
Bank master data as JSON object (only head, no content).
Bank master data as a JSON object (only head, no content).
head
Response
Response
head/bankmaster.json
iban
Bankmaster IBAN validation API
Public REST endpoint of the bank master iban validation api.
GET IBAN information
Validates the international bank account number (IBAN) and returns detail information if available.
get
Query Parameters
ibanstringrequired
International bank account number (IBAN) parameter of the API call.
>= 10 characters<= 100 characters
Response
application/json
Response
application/json
IBAN information
IbanResponse
IBAN validation result and IID if available.
validationResultstringrequired
Validation result. Possible values:
- OK # This IBAN is formally correct
- INVALID_COUNTRY_CODE # This IBAN has an invalid country code
- INVALID_LENGTH # This IBAN has an invalid length
- INVALID_FORMAT, # This IBAN is formally incorrect according to ISO-13616-1
- INVALID_CHECKSUM # This IBAN has an invalid checksum
- INVALID_IID # This IBAN has an invalid CH or LI institution identification (IID)
iidinteger
Each bank / financial institution is identified by an IID (institution identification). IIDs are three to five digits long. QR-IIDs consist exclusively of numbers from 30000 to 31999.
Example:9703
get/iban
Query Parameters
application/json
healthcheck
System Healthcheck
This allows to check the basic state of the API (can it be reached, does it respond).
Health check using GET method
Returns a status message of the system.
get
Response
application/json
Response
application/json
Healthcheck successful
HealthCheckResponse
messagestringrequired
Response message from health check.
<= 100 characters
Example:The health check GET request was successfully received and processed.
requestDateTimestring(date-time)required
According to RFC3339, section 5.6 in ISO 8601 with timezone and milliseconds.
Example:2023-01-21T10:52:05.1904957+01:00
receivedHeadersarray[object]required
Show Child Parameters
environmentStagestringrequired
The instance to which the request was sent to.
Example:X1
applicationVersionstringrequired
The version of the API backend.
Example:4.5.0-julia
apiVersionstringrequired
The version of the API.
Example:1.0.23
get/healthcheck
application/json