Skip to main content

Health Check

API details

Conciliation and Bank Slips API

These APIs are used for additional features such as generating and managing bank slips:

Introduction​

The Health Check endpoint lets you verify whether the Conciliation API is up and responding properly. This endpoint is useful for system monitoring, connectivity checks, and validating the API status.

Check API status​

HEAD /api/health-check

Checks whether the API is working properly and returns the system health status.

Data dictionary - Parameters​

This endpoint does not require input parameters.

API working properly
HTTP/1.1 200 OK

Data dictionary - Response​

STATUS CODEDESCRIPTION
200API is up and running properly

Use cases​

System monitoring​

Use this endpoint to implement automatic API health checks in your monitoring systems.

Connectivity check​

Test connectivity to the API before running critical operations.

Recommendations

Best practices for using Health Check:

  • Configure automatic checks every 1–5 minutes
  • Implement alerts based on consecutive failures
  • Use it as an initial test before critical operations
  • Set appropriate timeouts (recommended: 10–30 seconds)
Important

This endpoint:

  • Does not require authentication
  • Does not return sensitive data
  • Should respond quickly (< 5 seconds)
  • Can be used for frequent checks without rate-limiting impact