Skip to content
DocktDocktDOCKT

Get assessment

GET
/v1/assessments/{assessmentId}
curl --request GET \
  --url https://api.dockt.com/v1/assessments/ast_example \
  --header 'Authorization: Bearer <token>' \
  --header 'x-dockt-expected-workspace: wsp_example'

Returns assessment state, uploaded documents, review status, and latest decision summary. Requires assessments:read, decisions:read, documents:read, and social-compliance-packages:read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
assessmentId
required

Unique Dockt assessment identifier.

string

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.

Responses

Section titled “Responses”

200

Section titled “200”

Envelope for a single resource response.

Media typeapplication/json

Envelope for a single resource response.

object
object
required
string
Allowed values: single
data
required

A case containing one worker’s details, documents, and evaluation results in a Workspace. The Workspace configuration determines which requirements apply.

object
object
required
string
Allowed values: assessment
id
required

Unique Dockt assessment identifier.

string
workspace_id
required

Unique Dockt workspace identifier.

string
external_id
required
Any of:
string
job
required
Any of:

Namespaced customer job identifier resolved through the active Job Profile revisions.

object
namespace
required
string
>= 1 characters
external_id
required
string
>= 1 characters
resolved_job_profile_id
required
Any of:
string
status
required

Lifecycle state for an assessment.

string
Allowed values: created documents_pending processing assessed
worker
required
Any of:

Read-only summary of the worker identity Dockt can establish from the available information. All known nationalities are kept. Fields that remain unknown or conflicting are omitted.

object
name
string
>= 1 characters
nationalities
Array<string>
first_name
string
>= 1 characters
last_name
string
>= 1 characters
date_of_birth

ISO 8601 calendar date string.

string format: date
inputs
required
Array<object>
object
code
required
string
>= 1 characters
value
required
Any of:
Any of:
string
source
required
object
kind
required
string
Allowed values: integration operator
reference
required
string
>= 1 characters <= 240 characters
valid_from

ISO 8601 calendar date string.

string format: date
valid_until

ISO 8601 calendar date string.

string format: date
reconciliation
object
claim_ids
required
Array<string>
>= 1 items
reason
required
string
>= 1 characters <= 2000 characters
id
required
string
normalized_value
required
Any of:
Any of:
string
subject
required
string
recorded_at
required

ISO 8601 date-time string.

string format: date-time
superseded_by
required
Any of:
string
resolved_inputs
required
Array<object>

The value Dockt can use for a field, its sources, and how it is supported or verified. The status identifies values that are established, unknown, or conflicting.

object
code
required
string
label
required

Human-readable name shown in Dockt and customer systems.

string
>= 1 characters <= 120 characters
subject
required
string
status
required
string
Allowed values: established insufficient_information conflicting_information
value
required
Any of:
Any of:
string
assurance
required

Known values: declared, document_supported, authority_verified. New values may appear; preserve unfamiliar values and use a safe fallback.

string
>= 1 characters
reconciliation
object
claim_ids
required
Array<string>
reason
required
string
sources
required
Array<object>
object
claim_id
required
string
kind
required
string
reference
required
string
document_id
required
Any of:

Unique Dockt document identifier.

string
observed_at
required
Any of:

ISO 8601 date-time string.

string format: date-time
fresh_until
Any of:

ISO 8601 date-time string.

string format: date-time
value
required
Any of:
string
normalized_value
required
Any of:
string
input_requests
required
Array<object>

A question about details still needed to evaluate the requirements in your active policy. An incomplete Decision may be available while questions remain unanswered.

object
code
required
string
>= 1 characters
label
required

Human-readable name shown in Dockt and customer systems.

string
>= 1 characters <= 120 characters
value_type
required

Known values: string, integer, boolean, date, country_code, single_select. New values may appear; preserve unfamiliar values and use a safe fallback.

string
>= 1 characters
cardinality

Known values: one, many. New values may appear; preserve unfamiliar values and use a safe fallback.

string
>= 1 characters
max_items
integer
>= 1 <= 8
unit
string
>= 1 characters
options
required
Array<object>
object
value
required
string
>= 1 characters
label
required

Human-readable name shown in Dockt and customer systems.

string
>= 1 characters <= 120 characters
reason
required
string
>= 1 characters
applied_packages
required
Array<object>

Exact executable compliance-package release applied to an assessment.

object
code
required
string
>= 1 characters
version
required
string
>= 1 characters
requirements
required
Array<object>

Policy-neutral evidence requirement and its current assessment status.

object
code
required
string
>= 1 characters
label
required

Human-readable name shown in Dockt and customer systems.

string
>= 1 characters <= 120 characters
reason
required
Any of:
string
>= 1 characters
status
required

Current result of evaluating one evidence requirement.

string
Allowed values: missing not_required satisfied
required
required
boolean
source_domain
required
string
>= 1 characters
package
required
Any of:

Exact executable compliance-package release applied to an assessment.

object
code
required
string
>= 1 characters
version
required
string
>= 1 characters
accepted_evidence_types
required
Array<string>
supporting_document_ids
required
Array<string>
pending_document_ids
required
Array<string>
review_document_ids
required
Array<string>
invalid_document_ids
required
Array<string>
advisories
required
Array<object>

External or planning obligation signaled by an applied compliance package.

object
code
required
string
>= 1 characters
label
required

Human-readable name shown in Dockt and customer systems.

string
>= 1 characters <= 120 characters
reason
required
string
>= 1 characters
severity
required
string
Allowed values: info mandatory_external review_recommended
phase
required
Any of:
string
Allowed values: pre_access pre_start during_assignment payment_time post_assignment on_request
package
required

Exact executable compliance-package release applied to an assessment.

object
code
required
string
>= 1 characters
version
required
string
>= 1 characters
documents
required
Array<object>

Assessment-embedded summary of a canonical document, plus assessment-scoped match status.

object
object
required
string
Allowed values: document
id
required

Unique Dockt document identifier.

string
status
required

Processing lifecycle state for a workspace document.

string
Allowed values: uploaded processing completed failed withdrawn
document_result
required
Any of:

Document-intrinsic verdict produced after processing completes.

string
Allowed values: valid review_required invalid
match_status
required
Any of:

Result of deterministic document checks inside an assessment.

string
Allowed values: pending valid invalid mismatch no_profile unknown expired_no_profile
filename
required
string
>= 1 characters
classified_as
required
Any of:

Dockt document classification assigned after processing.

object
family
required
string
>= 1 characters
type
required
string
>= 1 characters
variant
required
Any of:
string
>= 1 characters
issues
required
Array<object>

Machine-readable document issue with a human-readable reason.

object
code
required
string
>= 1 characters
reason
required
string
>= 1 characters
uploaded_at
required

ISO 8601 date-time string.

string format: date-time
completed_at
required
Any of:

ISO 8601 date-time string.

string format: date-time
review
required

Whether the assessment needs manual review and the machine-readable reasons.

object
review_required
required
boolean
reason_codes
required
Array<string>
monitoring
required

Customer-safe periodic monitoring state for an assessment.

object
enabled
required
boolean
status
required
string
Allowed values: disabled active stopped ended point_in_time
next_reassessment_at
required
Any of:

ISO 8601 date-time string.

string format: date-time
monitoring_ends_at
required
Any of:

ISO 8601 date-time string.

string format: date-time
last_reassessed_at
required
Any of:

ISO 8601 date-time string.

string format: date-time
latest_decision
required
Any of:

Compact current decision with actionable findings projected into an assessment detail response.

object
decision_id
required

Unique Dockt decision identifier.

string
assessment_input_version
required
integer
>= 1
decision
required

Dockt decision for an assessment based on available worker context and evidence.

string
Allowed values: incomplete compliant non_compliant review_required
signal
required

Customer-facing traffic-light signal derived from the semantic decision.

string
Allowed values: green yellow red
explanation
required
string
>= 1 characters
findings
required
Array<object>
object
id
required
string
>= 1 characters
code
required
string
>= 1 characters
scope
required
string
Allowed values: assessment document requirement
impact
required
string
Allowed values: informational incomplete review_required non_compliant
title
required
string
>= 1 characters
explanation
required
string
>= 1 characters
document_ids
required
Array<string>
requirement_codes
required
Array<string>
recommendation
required
Any of:

Typed review-assistance recommendation captured with a decision.

object
action
required
string
Allowed values: approve review reject request_update
confidence
required
number
<= 1
mode
required
string
Allowed values: shadow review_assist
created_at
required

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
Example
{
  "object": "single",
  "data": {
    "object": "assessment",
    "id": "ast_example1042",
    "workspace_id": "wsp_example1042",
    "external_id": "worker-case-1042",
    "job": null,
    "resolved_job_profile_id": null,
    "status": "assessed",
    "inputs": [],
    "resolved_inputs": [],
    "worker": {
      "first_name": "Amina",
      "last_name": "Diallo",
      "date_of_birth": "1990-05-17",
      "nationalities": [
        "FR"
      ]
    },
    "input_requests": [],
    "applied_packages": [
      {
        "code": "social_construction_be_v1",
        "version": "v1"
      }
    ],
    "requirements": [
      {
        "code": "identity.worker",
        "label": "Identity document",
        "reason": "Confirm the identity of the worker being assessed.",
        "status": "satisfied",
        "required": true,
        "source_domain": "social",
        "package": {
          "code": "social_construction_be_v1",
          "version": "v1"
        },
        "accepted_evidence_types": [
          "identity_document"
        ],
        "supporting_document_ids": [
          "doc_example1042"
        ],
        "pending_document_ids": [],
        "review_document_ids": [],
        "invalid_document_ids": []
      }
    ],
    "advisories": [],
    "documents": [
      {
        "object": "document",
        "id": "doc_example1042",
        "status": "completed",
        "document_result": "valid",
        "match_status": "valid",
        "filename": "passport.pdf",
        "classified_as": {
          "family": "identity",
          "type": "passport_id",
          "variant": null
        },
        "issues": [],
        "uploaded_at": "2026-08-23T09:30:00Z",
        "completed_at": "2026-08-23T09:30:18Z"
      }
    ],
    "review": {
      "review_required": false,
      "reason_codes": []
    },
    "monitoring": {
      "enabled": true,
      "status": "active",
      "next_reassessment_at": "2026-08-24T09:31:00Z",
      "monitoring_ends_at": "2027-08-23T09:30:00Z",
      "last_reassessed_at": null
    },
    "latest_decision": {
      "decision_id": "dec_example1042",
      "assessment_input_version": 3,
      "decision": "compliant",
      "signal": "green",
      "explanation": "The available evidence satisfies every evaluated requirement for this assessment version.",
      "findings": [],
      "recommendation": null,
      "created_at": "2026-08-23T09:31:00Z"
    },
    "created_at": "2026-08-23T09:30:00Z",
    "updated_at": "2026-08-23T09:31: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"
}