Skip to content

List documents

GET
/v1/documents
curl --request GET \
--url 'https://api.dockt.com/v1/documents?limit=20&status=uploaded&assessment_id=ast_example&scope=standalone' \
--header 'Authorization: Bearer <token>'

Lists documents in the active workspace.

limit

Maximum number of resources to return. Defaults to 20 and cannot exceed 100.

integer
default: 20 >= 1 <= 100
Example
20

Maximum number of resources to return. Defaults to 20 and cannot exceed 100.

cursor

Opaque next_cursor value returned by the previous page.

string

Opaque next_cursor value returned by the previous page.

status

Processing lifecycle state for a workspace document.

string
Allowed values: uploaded processing completed failed withdrawn
assessment_id

Assessment identifier associated with a document.

string
/^ast_[A-Za-z0-9_]+$/
scope
string
Allowed values: standalone

Envelope for a paginated collection response.

Media type application/json

Envelope for a paginated collection response.

object
object
required
string
Allowed values: list
data
required
Array<object>

Compact document representation returned from collection reads.

object
object
required
string
Allowed values: document
id
required

Unique Dockt document identifier.

string
/^doc_[A-Za-z0-9_]+$/
workspace_id
required

Unique Dockt workspace identifier.

string
/^wsp_[A-Za-z0-9_]+$/
assessment_id
required
Any of:

Assessment identifier associated with a document.

string
/^ast_[A-Za-z0-9_]+$/
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
filename
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
classified_as
required
Any of:

Dockt document classification assigned after processing.

object
family
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
type
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
variant
required
Any of:
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
issues
required
Array<object>

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

object
code
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
reason
required
minLength(1)

A string at least 1 character(s) long

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
has_more
required
boolean
next_cursor
required
Any of:
string
Example
{
"object": "list",
"data": [
{
"object": "document",
"id": "doc_example",
"workspace_id": "wsp_example",
"assessment_id": "ast_example",
"status": "uploaded",
"document_result": "valid",
"uploaded_at": "2026-08-06T09:30:00Z",
"completed_at": "2026-08-06T09:30:00Z"
}
]
}

The request did not match the expected schema

Media type application/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"
}

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

Media type application/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"
}

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

Media type application/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"
}

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

Media type application/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"
}

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

Media type application/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"
}

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

Media type application/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",
"worker",
"nationality"
],
"message": "Expected a two-letter country code."
}
]
}
}

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

Media type application/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"
}

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

Media type application/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"
}