Verdocs - Authenticate

Request Body

application/json

Body Parameters

TypeScript Definitions

Use the request body type in TypeScript.

grant_type*string

The type of grant to request. API callers should nearly always use 'client_credentials'.

Value in"client_credentials" | "refresh_token" | "password"

client_id?string

If grant_type is client_credentials or refresh_token, the client ID of the API key to use.

Formatuuid

client_secret?string

If grant_type is client_credentials, the secret key of the API 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.

scope?string

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

curl -X POST "https://api.verdocs.com/v2/oauth2/token" \  -H "Content-Type: application/json" \  -d '{    "grant_type": "client_credentials"  }'

{}

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

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

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

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