Skip to main content

API Introduction

Welcome to the CareValidate API! Our API is organized around REST, a predictable and resource-oriented architectural style, accepts request bodies, returns JSON object responses and uses standard HTTP response codes, authentication.

Getting Started​

To get started with the CareValidate API, you will need to authenticate your requests. You need to send API keys in 'cv-api-key' header

All API requests must be made over HTTPS. Any calls made over plain HTTP will fail. Requests that do not include authentication will also fail.

Core Principles​

  • One Object Per Request: The CareValidate API does not support bulk updates. You can only work on a single object in each API request.
  • API Versioning: We are constantly improving our API. We release new versions to introduce new functionality and make improvements. Your account's API version can be managed in your dashboard settings.

Ready to dive in? Check out our Webhook Events section to see how you can receive real-time updates from our system.