Health Check

To ensure your integration is functioning correctly and the service is operational, we provide a dedicated health check endpoint.

Health Check Endpoint

URL:

https://se-webservice.apps.creditsafe.com/search/health

Sandbox URL:

https://se-webservice-sandbox.apps.creditsafe.com/search/health

Method: GET

Authentication: Not required (no token needed)

Purpose

This endpoint is designed to return a lightweight confirmation that the service is up and running. It should be used exclusively for service availability checks.

Never Use Regular Service Calls for Health Checks

Never use regular "fake" service calls for availability checks by:

Using invalid or random search criteria
Repeated queries against real companies or individuals
Automated loops that simulate usage

Such practices lead to:

Unnecessary load on the system, potentially affecting performance for all users
Incorrect usage charges billed to the customer
Data integrity risks, especially if test calls are indistinguishable from real usage
Compliance concerns, particularly when real personal or company data is involved

Best Practices

Always use the health check endpoint for system availability verification. It is:

✅ Free of charge - No billing or quota usage
✅ Safe for production environments - No data processing
✅ Designed for monitoring tools - Optimised for automated checks
✅ No authentication required - Quick and simple to implement

Responsible Use

Responsible use of service includes not overusing the health endpoint. Avoid excessive polling that could impact system performance. Use a minimum polling interval of 60 seconds for integrations exposed to external audiences. For other solutions, apply occasional polling only when needed, such as prior to executing batch processes or individual (on-demand) requests.

Health Response (Service is Healthy)

HTTP Response code: 200 OK

{
  "status": "healthy",
  "service": "Company Search (1225)",
  "timestamp": "2025-09-15T13:27:14.3794136Z",
  "version": "production"
}

Service Name

The service field returns different values depending on which Search endpoint was called:

Company Search: "Company Search (1225)"
Consumer Search: "Consumer Search (1226)"

Response Fields

Field	Type	Description
status	String	Health status of the service. `"healthy"` indicates the service is operational
service	String	Name of the service being checked
timestamp	String (DateTime)	ISO 8601 timestamp of when the health check was performed
version	String	Indicates the environment the service is running on. For customers this will always be `"production"`. A value of `"test"` or `"development"` indicates the service is not running on the Creditsafe production environment