Health check using GET method (only head, no content)

System Healthcheck
This allows to check the basic state of the API (can it be reached, does it respond).

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

Response

Content can be downloaded with GET method.

head/healthcheck

totalSizeintegerrequired

The total count of records in the entries list.

validOnstring(date)required

Master data is edited and published on a daily basis. Therefore the data is valid on that exact date only.

Example:2023-01-23

readTimestring(date-time)required

Date and time (according to ISO 8601) at which this response was created.

Example:2023-01-21T10:52:05.1904957+01:00

entriesarray[object]required

Show Child Parameters

Example

iidintegerrequired

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

validOnstring(date)required

Date to which the information in a record applies. This date (written as per ISO8601 standard) is identical for all records.

Example:2023-01-23

entryTypestringrequired

“New IID/QR-IID” must be used instead of “IID / QR-IID” if entryType is BankMasterConcatenated.

Allowed values:BankMasterConcatenatedBankMaster

Example

healthcheck