AuthV2

Get token

POST

Authenticating with the Candid Health API.

Candid Health utilizes the OAuth 2.0 bearer token authentication scheme in our auth flow. You obtain the bearer token for all subsequent API requests via the /auth/token endpoint defined below, which requires you to provide your client_id and client_secret. Your client_id and client_secret can be generated from the “Users & Credentials” tab by your org admin.

The bearer token should be provided in the Authorization header for all subsequent API calls.

Warning:

The bearer token expires 5 hours after it has been created. After it has expired, the client will receive an “HTTP 401 Unauthorized” error, at which point the client should generate a new token. It is important that tokens be reused between requests; if the client attempts to generate a token too often, it will be rate-limited and will receive an “HTTP 429 Too Many Requests” error.

Request

This endpoint expects an object.
client_id
stringRequired
Your application's Client ID.
client_secret
stringRequired
Your application's Client Secret.

Response

This endpoint returns an object
access_token
string
expires_in
integer
Time in seconds.
token_type
string

Errors

POST
1curl -X POST https://api.joincandidhealth.com/api/auth/v2/token \
2     -H "Content-Type: application/json" \
3     -d '{
4  "client_id": "YOUR_CLIENT_ID",
5  "client_secret": "YOUR_CLIENT_SECRET"
6}'
1{
2  "access_token": "eyJz93a...k4laUWw",
3  "expires_in": 86400,
4  "token_type": "Bearer"
5}
Built with