Authentication and permissions
Dockt authorizes every request from its authenticated principal, fixed or selected scope, and granted permissions.
Backend credentials
Section titled “Backend credentials”Both api_key and m2m credentials use bearer authentication for Dockt API requests. An API key is the bearer value. An M2M credential exchanges its client ID and one-time client secret at its returned token_url, then uses the short-lived access token as the bearer value.
Secret material is returned only when a credential is created. Later credential reads return metadata and a key hint, not the secret.
Credential scope
Section titled “Credential scope”An API credential has exactly one scope_type:
account: Manages the Account, its Workspaces, and account-scoped credentials.workspace: Operates within one Workspace for configuration and verification workflows.
The scope is fixed when the credential is created. The API doesn’t accept a request header or body field that changes it.
Browser sessions
Section titled “Browser sessions”Browser sessions can use POST /v1/auth/scope to select an available Account or Workspace. The active selection applies to later session requests. API credentials can’t call this operation to change their fixed scope.
Use GET /v1/auth/me to read the current authentication type, scope, permissions, available session scopes, and active scope.
Account permissions
Section titled “Account permissions”| Permission | Allows |
|---|---|
account:read | Read the current Account. |
account:write | Update Account metadata and manage account users where applicable. |
workspaces:read | List and read Account Workspaces. |
workspaces:write | Create and update Account Workspaces. |
api-credentials:read | List credential metadata. |
api-credentials:manage | Create, update, disable, and delete credentials. |
features:read | Read Workspace Features where the account operation supports it. |
features:write | Update Workspace Features where the account operation supports it. |
social-compliance-packages:read | Read the social compliance package catalog. |
Workspace permissions
Section titled “Workspace permissions”| Permission | Allows |
|---|---|
workspace:read | Read the active Workspace. |
features:read | Read active Workspace Features. |
features:write | Update active Workspace Features. |
social-compliance-packages:read | Read the social compliance package catalog. |
webhooks:manage | Create, read, update, delete, and test webhook endpoints. |
api-credentials:read | List Workspace credential metadata. |
api-credentials:manage | Create, update, disable, and delete Workspace credentials. |
assessments:read | List and read Assessments. |
assessments:write | Create and update Assessments and manage linked Documents. |
documents:read | List and read Documents. |
documents:create | Upload Documents. |
documents:delete | Withdraw standalone Documents. |
decisions:read | Read Decisions and Outcomes. |
decisions:outcome | Report a Decision Outcome. |
The exact permission required by each operation appears in the API reference.
Authentication failures
Section titled “Authentication failures”A 401 Unauthorized response means the bearer value is missing, invalid, expired, or no longer enabled. The response includes WWW-Authenticate.
A 403 Forbidden response means authentication succeeded, but the credential scope or permission doesn’t allow the operation. Check GET /v1/auth/me before changing application logic or credentials.