Skip to content
Dockt Dockt DOCKT

Get started with Dockt

This section takes you from a new Dockt workspace to a verified API connection, then points you to the right first workflow. You don’t need to understand every API resource before you begin.

Dockt is designed for backend integration. Your application collects the worker information or document, your backend sends it to Dockt, and your application presents or acts on the structured result. Dockt API credentials and uploaded files should never pass through untrusted client code.

Before you begin

Section titled “Before you begin”

You need:

  • A Dockt account and workspace.
  • Access to create a workspace API credential in the Dockt control plane.
  • A backend or server-side function that can keep credentials and uploaded files private.
  • curl and jq for the examples.

Never put API keys, client secrets, document bytes, or webhook signing secrets in browser or mobile code.

Integration path

Section titled “Integration path”
  1. Create and store a workspace credential.
  2. Call /v1/auth/me to confirm its scope and permissions.
  3. Plan your backend integration and decide which Dockt IDs your application stores.
  4. Choose a first workflow:
  5. Receive signed webhooks before moving asynchronous processing into production.
  6. Test the integration in a separate Workspace.
  7. Review the production checklist.

The standalone Document guide is the smaller starting point. It teaches upload, asynchronous processing, and result handling with one file. The Assessment guide adds worker context, evidence requirements, and versioned Decisions.

What Dockt returns

Section titled “What Dockt returns”

Dockt uses normal HTTP responses and JSON resource envelopes. Uploads are asynchronous: the first response confirms acceptance and gives you an ID, while a later read or webhook tells you that processing has finished.

For a Document, the final result answers whether the file passed its applicable checks, needs review, or is invalid. For an Assessment, the latest Decision answers whether the current worker case is incomplete, compliant, needs review, or is non-compliant. Both include structured details so you can explain the result and choose the next step in your own workflow.

Base URL and API version

Section titled “Base URL and API version”

Send production requests to:

https://api.dockt.com/v1

The /v1 prefix is part of every product API route. The machine-readable contract is available at OpenAPI JSON.

Use the public documentation and OpenAPI contract to build and validate your integration.

Choose a credential scope

Section titled “Choose a credential scope”

An Account is your top-level Dockt customer boundary. A Workspace is an isolated operational environment inside that Account. Most integrations use a separate Workspace for each environment or operational boundary they need to keep isolated.

Use a workspace credential for document, assessment, Decision, Features, and webhook operations. The credential always acts in its assigned Workspace, so your requests don’t need to include a Workspace selector.

Use an account credential only when your integration must manage the account, workspaces, or account-scoped credentials. Most verification backends need only a workspace credential.

Choose a credential type

Section titled “Choose a credential type”

An api_key is an opaque bearer secret and is the shortest path to a first request. An m2m credential uses a client ID and secret to obtain short-lived access tokens. Both authenticate Dockt API requests with the Authorization: Bearer header.

Compare credential types