Getting Started

Authentication

An API key is required to get started. Follow these steps:

Navigate to the Settings tab and Developer section

Generate a new API key

Store your API key securely. It won’t be displayed again after generation.

Requests are authenticated with the API (secret) key in the request header:

x-api-key: YOUR_API_KEY

Example

cURL

curl --request POST \
     --url 'https://api.readyhealth.com/document/{id}' \
     --header 'Accept: application/json' \
     --header 'x-api-key: YOUR_API_KEY'

Sandbox Test Environment

We offer a sandbox developer API environment at api-sandbox.readyhealth.com that enables testing the functionality of api.readyhealth.com. The sandbox requires a separate API key that is available in the Settings page of the Admin Dashboard. Once you have your Sandbox API key, you can immediately start testing our API, either from our API Reference or from your development environment.

We aim for high parity between the sandbox and production environment. However, there may be differences in performance and latency. New features are released first to the sandbox environment before general release to production.

Status Codes

Status Code	Description
200	Request is Successful
201	Resource Created
400	Invalid Request
401	Invalid Authentication
403	Invalid Permissions
404	Resource not found
5XX	Internal Server Error

The error response also contains a descriptive message to communicate the issue.

{
     "statusCode": 404,
     "message": "Cannot DELETE /document/123",
     "error": "Not found" 
}

Requirement Lifecycle

Document Processing

Searches

Statements

Getting Started

Authentication

Example

Sandbox Test Environment

Status Codes

File types

File Limitations

​Authentication

​Example

​Sandbox Test Environment

​Status Codes

​File types

​File Limitations

Authentication

Example

Sandbox Test Environment

Status Codes

File types

File Limitations