Dockt documentation

Dockt helps your product answer two related questions: what does an uploaded document show, and does a worker’s complete set of information satisfy the requirements that apply to them?

Your backend sends worker information and documents to the Dockt API. Dockt processes that information asynchronously and returns structured results that your product can store, display, or route to a reviewer. You keep control of the user experience and the action your product takes.

Use the production API at https://api.dockt.com. Authenticate backend requests with a workspace API credential.

Choose your workflow

Verify one document

Choose a standalone Document when one file can be handled on its own. For example, you may want to identify the document type, extract its public facts, run applicable checks, and decide whether the file can continue or needs review.

Upload the PDF or image to POST /v1/documents. The completed Document contains a result of valid, review_required, or invalid, together with the details that explain that result.

Verify a document end to end

Evaluate one worker

Choose an Assessment when the answer depends on more than one file. An Assessment brings together one worker’s identity, the circumstances you are evaluating, and all supporting Documents.

Dockt first tells you which additional context and evidence the Assessment needs. As you provide them, Dockt evaluates the current case and creates a Decision that explains whether it is incomplete, compliant, needs review, or is non-compliant.

Complete an assessment end to end

The four resources to understand

• A Workspace is the environment in which your configuration, credentials, Documents, Assessments, and webhooks live.
• A Document represents one uploaded PDF or image and its processing result.
• An Assessment represents the complete case for one worker at a point in time.
• A Decision is an immutable evaluation of one version of an Assessment.

These resources build on each other. A standalone Document can be used by itself. Documents uploaded to an Assessment become evidence for that Assessment. The Assessment’s current inputs and evidence produce a Decision.

How an integration fits together

1. Create a workspace credential with the permissions your backend needs.
2. Decide whether your workflow needs one standalone Document or a complete Assessment.
3. Send the information available in your product and upload each document from your backend.
4. Follow Dockt’s response: provide requested Assessment inputs or evidence when needed.
5. Wait for processing by polling during development or receiving signed webhooks in production.
6. Read the completed Document result or the Assessment’s latest Decision and its explanation.
7. Store Dockt resource IDs alongside your own records for later reads, reconciliation, and support.

Dockt processes uploads asynchronously. A successful upload means the file was accepted, not that verification is complete.

Understand the results

A standalone Document finishes with valid, review_required, or invalid. This result describes the file and the checks that apply to it; it does not evaluate the worker’s complete situation.

An Assessment Decision is incomplete, compliant, review_required, or non_compliant. It evaluates the complete Assessment input version and includes a green, yellow, or red signal for display.

Use the semantic result as the source of truth. The accompanying requirements, Findings, issues, and explanations tell you why Dockt returned that result and what your product may need to ask the user to do next.

Start integrating

Begin with Get started to configure authentication and make a first API call. Use the API reference for exact fields, response schemas, permissions, and status codes.