Business Health Check

Get Business Health Status

This endpoint retrieves the health status of FIRS MBS.

Request

  • MethodGET
  • Endpoint/api/dev/external/businesses/:businessId/health
  • Path Parameters:
    • businessId (string): The unique identifier of the business for which the health status is being queried.

Response

The response will return a JSON object indicating the health status of the specified business. The structure of the response may vary, but it is expected to include relevant health information.

Example Response

Copy to Clipboard

The response will typically include fields that indicate the operational status of the business, but the specific fields are not detailed in this documentation.

Request

Path Params

Path Param Type Required Example
stage string required
businessId string required

Header Params

Header Type Required Example
X-Business-Key string required BK-26EDE24BAC50475FAACC5EA6339F0863-DEV-B2Z6QCEHI3X9
Accept string required */*

Response

Response Status

  • 200 OK

  • 201 Created

  • 401 Unauthorized

  • 403 Forbidden
  • 404 Not Found