Skip to content

Assessments

Dockt checks a worker’s documents and details against the requirements you configure for their work. Each worker case is called an Assessment. It holds their identity, assignment details, documents, and results.

A Workspace groups your cases and the settings that determine which requirements apply.

Create one Assessment for one case in your system. Use its external_id to link it to your own worker, onboarding, assignment, or access record. As the case changes, update the existing Assessment instead of creating a replacement for every new document.

You can add information and documents to an Assessment over time. Each evaluation produces a Decision: a saved result that records what Dockt concluded from that version of the case. Earlier Decisions stay unchanged.

Create an Assessment with the information your product already knows:

  • inputs: details about the worker, employment, assignment, employer, project, or evaluation date. Each value includes its source. You can provide some details or start with none.
  • external_id: an optional identifier from your system.
  • job: an optional job reference from your system. A matching Job Profile adds the qualification requirements configured for that job.

Dockt compares the details you provide with information from documents and external sources. resolved_inputs shows which values agree, which conflict, and which are still unknown. It also shows where each value came from and whether it was provided, supported by a document, or independently verified. The worker response summarizes the known identity details; you can’t write to it directly.

Documents can fill missing details when they match the worker and assignment and don’t conflict with the other information.

If a check needs more details, Dockt lists the details it still needs in input_requests. Your application can use this list to find known values in the system you connect to Dockt. Each entry includes the field code, value type, reason, and allowed options when applicable. Don’t turn this list into a form for users to complete.

Dockt can produce an incomplete Decision while details are still missing. A null latest_decision means no current Decision is available yet.

Update inputs with PATCH /v1/assessments/{assessmentId}. A correction replaces the current value only for the same field code and source. Dockt keeps the earlier value in the history, preserves other sources, and leaves earlier Decisions unchanged.

Assessment status tells you what Dockt is currently doing. It is not the compliance result.

An Assessment has one of these statuses:

  • created: The Assessment exists and can accept input or evidence.
  • documents_pending: An accepted linked Document is still processing. Show “Running assessment” while Dockt waits for it.
  • processing: Dockt is evaluating the current inputs.
  • assessed: A current Decision is available.

After assessed, read latest_decision.decision for the result. An assessed case can still be incomplete, review_required, or non_compliant; assessed only means a Decision was produced.

Periodic reassessment checks a case again after its first Decision. Dockt uses the current policy and available evidence without processing the linked Documents again.

Monitoring Policy sets how often Dockt checks the case and for how long. The dates you provide also control monitoring:

  • assignment.start_date schedules a fresh reassessment on the first assignment date. Monitoring can also run before that date.
  • assignment.end_date is inclusive. Dockt doesn’t schedule reassessment after that date.
  • If you omit assignment.end_date, the Workspace maximum duration bounds monitoring from the Assessment creation time.
  • assessment.evaluation_date makes the Assessment point-in-time and disables periodic monitoring.

The Assessment monitoring object reports whether monitoring applies, its status, the next scheduled time, the monitoring end, and the most recent reassessment time. Use status to distinguish active, stopped, ended, disabled, and point_in_time monitoring.

To stop monitoring for one Assessment, update it with:

{
"monitoring_enabled": false
}

Set monitoring_enabled to true to resume monitoring when the Workspace settings and monitoring window allow it. Stopping or resuming monitoring doesn’t change linked Documents or the current Decision.

During reassessment, the previous Decision remains current until Dockt saves the replacement. Every scheduled reassessment creates a new permanent Decision, even when the result is unchanged. Dockt sends an assessment.reassessed event only when the result, requirements, or Findings change. Findings are the explanations of issues Dockt identified.

Start with the PDFs or images the user has. Upload each file to POST /v1/assessments/{assessmentId}/documents. Dockt identifies the document type and reads its details. Each upload creates a Document record linked to the Assessment.

The Assessment’s requirements list the evidence needed for this worker. Evidence means documents or other information that support a check. Use this list to show what is missing or incorrect.

The Document is processed first. Its result then contributes to the Assessment requirement it supports. Read each Document’s status to track its processing. The Assessment’s documents_pending status tracks accepted uploads that are still processing.

Dockt evaluates the current Assessment whenever no accepted linked Document is still processing. This means an Assessment can receive an incomplete, review_required, or non_compliant Decision with no or partial evidence.

A later upload, withdrawn Document, updated worker or assignment details, activated Assessment Policy, or activated relevant Job Profile can produce a newer Decision. Earlier Decisions remain unchanged, so you can identify which result your product acted on.

These three collections answer different questions:

  • input_requests: What other details does Dockt need to determine or check the requirements?
  • requirements: Which evidence applies, and has acceptable evidence satisfied it?
  • review and Decision findings: Why does the current result need attention, and what should a reviewer inspect?

Read these collections together. Add the documents and details your system already has. Checks with enough information can continue while other details are missing. Dockt adds a conditional requirement only when it can determine that the requirement applies.

If Dockt has too little information to check the worker, show one short summary that explains this. Don’t display a separate question for every missing detail.

The Assessment detail response is the current working view of the case:

  • inputs for the information provided and its history, and resolved_inputs for the values Dockt uses, their sources, conflicts, and verification level.
  • input_requests for missing details your application may be able to supply.
  • requirements and their evidence status.
  • advisories for external or planning obligations.
  • documents as linked Document summaries.
  • review with machine-readable reason codes.
  • monitoring with the current periodic reassessment state and dates.
  • latest_decision with the current result and Findings.

Use latest_decision for a list or status screen. When your application acts on the result, or a reviewer needs the full record, use latest_decision.decision_id to call GET /v1/decisions/{decisionId}. The response contains the saved result, the values Dockt evaluated, their sources, and the Document results.

Complete an assessment

Assessment input codes and value types