GET/transactional-api/ping

Ping

Connectivity and authentication check. Returns the calling application together with the requesting organisation and practitioner context.

Authorization: Bearer token (JWT). See Authentication.

Responses

200 API is reachable and the caller is authenticated.

Response fields

Field	Type	Description
status	string
timestamp	string<date-time>
application.identifier	string
application.name	string
requestingOrganisation	object
requestingPractitioner	object (nullable)

{
  "status": "ok",
  "timestamp": "2026-01-15T09:00:00Z",
  "application": {
    "identifier": "medicus-test",
    "name": "Medicus Test API Consumer"
  },
  "requestingOrganisation": {
    "organisationName": "Dr MA Baird's Practice",
    "organisationIdentifierType": "nhs-england-ods-code",
    "organisationIdentifierValue": "A81001"
  },
  "requestingPractitioner": {
    "displayName": "Dr Sarah Ahmed",
    "name": null,
    "practitionerIdentifierType": "gb-nhs-gp-connect-practitioner-id",
    "practitionerIdentifierValue": "G1234567"
  }
}