Authentication

You'll need to authenticate your requests to access any of the endpoints in the SOAP Note API. In this guide, we'll look at how authentication works. SOAP Note API uses an API key in the Authorization header to authenticate requests.

Obtaining an API Key

To get an API key for the SOAP Note API:

1. Email hello@soapnoteapi.com to request access.
2. Once approved, you'll receive your unique API key.

Always keep your API key safe and reset it if you suspect it has been compromised.

Using the API Key

Here's how to add the API key to the request header using cURL:

curl https://prod.soapnoteapi.com/v1/note \
  -H "Authorization: Bearer YOUR_API_KEY_HERE"

Replace YOUR_API_KEY_HERE with the actual API key you received.

Permissions

Your API key grants you access to all operations available in the SOAP Note API, subject to any usage limits or restrictions that may apply.

Error Handling

If you provide an invalid API key or unauthorized access is attempted, you'll receive a 401 Unauthorized error:

{
  "status": "error",
  "error_code": "UNAUTHORIZED",
  "message": "Invalid API key provided. Please check your credentials and try again."
}

If you encounter this error, double-check that you're using the correct API key and that it's properly included in the Authorization header.