Skip to content
DocktDocktDOCKT

Create account API credential

POST
/v1/account/api-credentials
curl --request POST \
  --url https://api.dockt.com/v1/account/api-credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-dockt-expected-workspace: wsp_example' \
  --data '{ "display_name": "example", "description": "example", "credential_type": "api_key", "allowed_scopes": "example", "expires_at": "2026-08-06T09:30:00Z" }'

Creates an account-scoped machine credential. The returned secret is shown once and cannot be retrieved later.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-dockt-expected-user

Rejects the request with 401 unless the browser session belongs to this auth_user_id. This assertion does not grant authority.

string
>= 1 characters
x-dockt-expected-workspace

Unique Dockt workspace identifier.

idempotency-key

Caller-generated retry key for duplicate-sensitive create and resend operations. Keys are scoped to the authenticated principal, method, and route and are retained for 24 hours.

string
>= 1 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Creates a machine credential that can manage account-level resources.

object
display_name
required

Human-readable name shown in Dockt and customer systems.

string
>= 1 characters <= 120 characters
description
string
credential_type
string
Allowed values: api_key m2m
default: api_key
allowed_scopes
expires_at
string format: date-time

Responses

Section titled “Responses”

201

Section titled “201”

Envelope for a single resource response.

Media typeapplication/json

Envelope for a single resource response.

object
object
required
string
Allowed values: single
data
required

Newly created credential with one-time secret material included in the response.

object
object
required
string
Allowed values: api_credential
id
required

Unique Dockt API credential identifier.

string
account_id
required
Any of:

Unique Dockt account identifier.

string
workspace_id
required
Any of:

Unique Dockt workspace identifier.

string
display_name
required

Human-readable name shown in Dockt and customer systems.

string
>= 1 characters <= 120 characters
description
required
Any of:
string
credential_type
required

Credential format. API keys are bearer secrets; machine-to-machine credentials use a client credential exchange.

string
Allowed values: api_key m2m
scope_type
required

Whether the credential acts across an account or only within one workspace.

string
Allowed values: account workspace
client_id
required
Any of:
string
>= 1 characters
token_url
required
Any of:

Absolute HTTPS URI.

string format: uri
/^https:\/\//
api_key_hint
required
Any of:
string
>= 1 characters
allowed_scopes
required
Array<string>
Allowed values: account:read account:write workspaces:read workspaces:write api-credentials:read api-credentials:manage social-compliance-packages:read workspace:read workspace-configuration:read assessment-policy:write job-profiles:write monitoring-policy:write notifications:manage assessments:read assessments:write documents:read documents:create documents:delete decisions:read decisions:outcome
enabled
required
boolean
last_used_at
required
Any of:

ISO 8601 date-time string.

string format: date-time
created_at
required

ISO 8601 date-time string.

string format: date-time
updated_at
required

ISO 8601 date-time string.

string format: date-time
client_secret
required
Any of:
string
>= 1 characters
api_key
required
Any of:
string
>= 1 characters
Example
{
  "object": "single",
  "data": {
    "object": "api_credential",
    "account_id": "acc_example",
    "workspace_id": "wsp_example",
    "credential_type": "api_key",
    "scope_type": "account",
    "token_url": "https://example.com/webhooks/dockt",
    "allowed_scopes": [
      "account:read"
    ],
    "last_used_at": "2026-08-06T09:30:00Z",
    "created_at": "2026-08-06T09:30:00Z",
    "updated_at": "2026-08-06T09:30:00Z"
  }
}

400

Section titled “400”

Problem Details response for HTTP 400. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/invalid-request",
  "title": "Bad request",
  "status": 400,
  "detail": "The request did not match the expected schema.",
  "instance": "req_example1042"
}

401

Section titled “401”

Problem Details response for HTTP 401. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/missing-auth",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Send a valid bearer token or browser session.",
  "instance": "req_example1042"
}

403

Section titled “403”

Problem Details response for HTTP 403. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/forbidden",
  "title": "Forbidden",
  "status": 403,
  "detail": "The authenticated principal does not have the required permission.",
  "instance": "req_example1042"
}

404

Section titled “404”

Problem Details response for HTTP 404. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/not-found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource was not found in the authenticated scope.",
  "instance": "req_example1042"
}

409

Section titled “409”

Problem Details response for HTTP 409. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "detail": "The request conflicts with the current resource state.",
  "instance": "req_example1042"
}

422

Section titled “422”

Problem Details response for HTTP 422. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/validation",
  "title": "Validation failed",
  "status": 422,
  "detail": "Correct the invalid fields and send the request again.",
  "instance": "req_example1042",
  "errors": {
    "issues": [
      {
        "path": [
          "body",
          "inputs",
          "3",
          "value"
        ],
        "message": "Expected a two-letter country code."
      }
    ]
  }
}

429

Section titled “429”

Problem Details response for HTTP 429. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/rate-limit",
  "title": "Too many requests",
  "status": 429,
  "detail": "Wait for the Retry-After interval before retrying.",
  "instance": "req_example1042"
}

500

Section titled “500”

Problem Details response for HTTP 500. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "type": "https://docs.dockt.com/errors/internal",
  "title": "Internal server error",
  "status": 500,
  "detail": "Retry the request safely or contact Dockt support with the request ID.",
  "instance": "req_example1042"
}

503

Section titled “503”

Problem Details response for HTTP 503. The type URI is the stable machine-readable error code.

Media typeapplication/problem+json

Standard error response with a stable status, human-readable detail, and optional validation errors.

object
type
required
string
title
required
string
status
required
number
detail
required
string
instance
required
Any of:

Request identifier that Dockt support can use to trace an API call.

string
errors

Structured request validation issues.

object
issues
required
Array<object>

One request validation issue with a stable field path and human-readable message.

object
path
required
Array
message
required
string
Example
{
  "instance": "req_example1042"
}