Authenticate

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

grant_type*login

The type of grant to request. API callers should nearly always use 'client_credentials'. Third-party OAuth2 integrations use 'authorization_code'. The mfa-otp and mfa-recovery-code grants complete a sign-in that was answered with an 'mfa_required' challenge, and the login-code grant completes a Google or Microsoft sign-in.

Value in"client_credentials" | "refresh_token" | "password" | "authorization_code" | "urn"

client_id?string

If grant_type is client_credentials, refresh_token, or authorization_code, the client ID to use.

Formatuuid

client_secret?string

If grant_type is client_credentials or authorization_code, the secret key to use.

Formatuuid

username?string

If grant_type is password, the username to authenticate with.

password?string

If grant_type is password, the password to authenticate with.

code?string

If grant_type is authorization_code, the authorization code received from the authorize endpoint.

redirect_uri?string

If grant_type is authorization_code, must match the redirect_uri used in the authorize request.

Formaturi

mfa_token?string

If grant_type is an MFA type, the token returned from the challenge.

otp?string

If grant_type is an MFA-with-OTP type, the six-digit code from the user's authenticator.

recovery_code?string

If grant_type is an MFA-with-recovery-code type, the backup code.

login_code?string

If grant_type is a PKCE type, the login code from the IdP.

code_verifier?string

If grant_type is is a PKCE type, the PKCE verifier from the challenge.

scope?string

Optional scope to limit the auth token to. Do not specify this unless you are instructed to by a Verdocs Support rep.

Response Body

`application/json`

curl -X POST "https://api.verdocs.com/v2/oauth2/token" \    -H "Authorization: Bearer ACCESS_TOKEN" \    -H "content-type: application/json" \    -d '{"param": "value"}'

{
  "refresh_token": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

{
  "status": "ERROR",
  "error": "string"
}

Authenticate

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

406application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`