{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-country-apis-catalog/product-catalog/se/searchEngine/sidebars.yaml","current-catalog-info":"current-catalog-info-/country-apis-catalog/product-catalog/se/searchengine/openapi"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Health Check","llmstxt":{"hide":true}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"health-check","__idx":0},"children":["Health Check"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To ensure your integration is functioning correctly and the service is operational, we provide a dedicated health check endpoint."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"health-check-endpoint","__idx":1},"children":["Health Check Endpoint"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["URL:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"https://se-webservice.apps.creditsafe.com/search/health\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sandbox URL:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"https://se-webservice-sandbox.apps.creditsafe.com/search/health\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method:"]}," GET"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication:"]}," Not required (no token needed)"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"purpose","__idx":2},"children":["Purpose"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"danger","name":"Never Use Regular Service Calls for Health Checks"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Never"]}," use regular \"fake\" service calls for availability checks by:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Using invalid or random search criteria"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Repeated queries against real companies or individuals"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Automated loops that simulate usage"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Such practices lead to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Unnecessary load on the system, potentially affecting performance for all users"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Incorrect usage charges billed to the customer"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Data integrity risks, especially if test calls are indistinguishable from real usage"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Compliance concerns, particularly when real personal or company data is involved"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":3},"children":["Best Practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Always use the health check endpoint for system availability verification. It is:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Free of charge"]}," - No billing or quota usage",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Safe for production environments"]}," - No data processing",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Designed for monitoring tools"]}," - Optimised for automated checks",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"✅ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No authentication required"]}," - Quick and simple to implement"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Responsible Use"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Responsible use of service includes ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not overusing the health endpoint"]},". Avoid excessive polling that could impact system performance. Use a minimum polling interval of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["60 seconds"]}," for integrations exposed to external audiences. For other solutions, apply ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["occasional polling only when needed"]},", such as prior to executing batch processes or individual (on-demand) requests."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"health-response-service-is-healthy","__idx":4},"children":["Health Response (Service is Healthy)"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"http-response-code-200-ok","__idx":5},"children":["HTTP Response code: 200 OK"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"status\": \"healthy\",\n  \"service\": \"Company Search (1225)\",\n  \"timestamp\": \"2025-09-15T13:27:14.3794136Z\",\n  \"version\": \"production\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Service Name"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service"]}," field returns different values depending on which Search endpoint was called:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Company Search:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Company Search (1225)\""]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consumer Search:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Consumer Search (1226)\""]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-fields","__idx":6},"children":["Response Fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Health status of the service. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"healthy\""]}," indicates the service is operational"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["service"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the service being checked"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["timestamp"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String (DateTime)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO 8601 timestamp of when the health check was performed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["version"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates the environment the service is running on. For customers this will always be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"production\""]},". A value of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"test\""]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"development\""]}," indicates the service is not running on the Creditsafe production environment"]}]}]}]}]}]},"headings":[{"value":"Health Check","id":"health-check","depth":1},{"value":"Health Check Endpoint","id":"health-check-endpoint","depth":2},{"value":"Purpose","id":"purpose","depth":2},{"value":"Best Practices","id":"best-practices","depth":2},{"value":"Health Response (Service is Healthy)","id":"health-response-service-is-healthy","depth":2},{"value":"HTTP Response code: 200 OK","id":"http-response-code-200-ok","depth":3},{"value":"Response Fields","id":"response-fields","depth":3}],"frontmatter":{"seo":{"title":"Health Check"}},"lastModified":"2026-08-03T10:46:01.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/country-apis-catalog/product-catalog/se/searchengine/documentation/healthcheck","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}