Service Monitoring

Checking System Liveness

To check the liveness of our service, you can call a special function without side effects. This function only checks the basic server availability.

Method and URL

[GET] https://customer.identity.tm/api/2.10/serverStatus

HTTP Codes

200 Service available
500 Service not available
None Service not available

Checking System Status

The system continually monitors its own status. To query information, you can call this function at any time.

Please note, that the availability of mailing only reflects our internal mailing system. If you gave us an external mailing service to use, this service will not be monitored for you.

Furthermore, information about AES will only be available if your account has been configured to provide AES functionality.

Method and URL

[GET] https://customer.identity.tm/api/2.10/systemStatus

Response Data

Element	Parent	Type	Len	Occ	Description
serverAlive	[ROOT]	B		Y	Servers are running
apiAvailable	[ROOT]	B		Y	Customer API working
videoAvailable	[ROOT]	B		Y	Video system working
mailingAvailable	[ROOT]	B		Y	Mail-System available
smsTanAvailable	[ROOT]	B		Y	SMS TAN working
autoIdentAvailable	[ROOT]	B		Dep	IDnow AutoIdent servers alive Only if enabled
assureIdAvailable	[ROOT]	B		Dep	AssureID servers alive Only if enabled
readIdAvailable	[ROOT]	B		Dep	ReadID servers alive Only if enabled
iProovAvailable	[ROOT]	B		Dep	iProov servers alive Only if enabled
eSign	[ROOT]	O		Dep	Only if eSign is enabled
serverAlive	eSign	B		Dep	QES servers alive
qesAvailable	eSign	B		Dep	QES systems working
fesServerAlive	eSign	B		Dep	AES servers alive
fesAvailable	eSign	B		Dep	AES systems working

HTTP Codes

200 OK, JSON document in body

401 Authentication failed, please check username and password

500 Services not available at all

None Services not available at all

Example Request

[GET] https://customer.identity.tm/api/2.10/systemStatus

Example Response

{
  "serverAlive": true,
  "apiAvailable": true,
  "videoAvailable": true,
  "mailingAvailable": true,
  "smsTanAvailable": true,
  "eSign": {
    "serverAlive": true,
    "qesAvailable": true,
    "fesServerAlive": true,
    "fesAvailable": true
  }
}