Authentication

Clarify uses OAuth and currently supports the Authorization Code, Authorization Code with Proof Key for Code Exchange (PKCE) and Refresh Token grants. We create OAuth apps for trusted partners, please reach out [email protected] to get one created for you.

Clarify support will ask you a few questions and provide the following information:

Client ID
Client Secret if you requested private application (i.e. one that can securely store the client secret)
Scopes openid profile email offline_access
Authorization endpoint https://auth1.clarify.ai/oauth2/authorize
Token endpoint https://auth1.clarify.ai/oauth2/token
Refresh token endpoint https://auth1.clarify.ai/oauth2/token

A typical, complete OAuth flow looks something like the following.

<aside> ⚠️

Replace {your-redirect-uri}, and {your-code} in the actual HTTP request.

</aside>

First, get your authorization code grant:

GET <https://auth1.clarify.ai/oauth2/authorize?response_type=code&client_id={your_client_id}&scope=openid%20profile%20email%20offline_access&redirect_uri={your_redirect_url}>

// no headers
// no body

Second, get your tokens:

POST <https://auth1.clarify.ai/oauth2/token>

// headers
Content-Type: application/x-www-form-urlencoded

// request body
grant_type: "authorization_code"
code: "{your-code}"
redirect_uri: "{your_redirect_uri}"
client_id: "{your_client_id}"
client_secret: "{your_client_secret}"