Skip to content
Dockt Dockt DOCKT

Create document

POST
/v1/documents
 
curl --request POST \
  --url https://api.dockt.com/v1/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form file=@file

Uploads one standalone document for asynchronous document-intelligence processing.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
idempotency-key
minLength(1)

Caller-generated retry key for duplicate-sensitive create and resend operations. Keys are scoped to the authenticated principal, method, and route and are retained for 24 hours.

string
>= 1 characters

Caller-generated retry key for duplicate-sensitive create and resend operations. Keys are scoped to the authenticated principal, method, and route and are retained for 24 hours.

Request Body required

Section titled “Request Body required ”
Media type multipart/form-data

One standalone document upload.

object
file
required

One PDF or image file, no larger than 10 MB.

string format: binary

Responses

Section titled “ Responses ”

202

Section titled “202 ”

Envelope for a single resource response.

Media type application/json

Envelope for a single resource response.

object
object
required
string
Allowed values: single
data
required

Canonical workspace document and public document-intelligence projection.

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
facts
required

Public extracted facts keyed by normalized claim key. Empty keys and raw_text are omitted.

object
key
additional properties
Array<object>
>= 1 items

One extracted value for a public document fact key.

object
value
required
Any of:
string
confidence
required
Any of:
lessThanOrEqualTo(1)

A number less than or equal to 1

number
<= 1
verifications
required
Array<object>

One authority or registry check. An empty verifications array means no check applies only when the document status is completed; before completion it means no result is available.

object
status
required

Status for one authority or registry verification check.

string
Allowed values: verified not_found invalid expired error not_checked
source
required
Any of:
minLength(1)

A string at least 1 character(s) long

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

A string at least 1 character(s) long

string
>= 1 characters
enrichment
required

Document enrichment outcome, kept separate from the intrinsic document verdict.

object
status
required
string
Allowed values: pending completed completed_with_warnings failed
checks
required
Array<object>

One safe, customer-visible evidence-discovery outcome from document enrichment.

object
code
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
status
required
string
Allowed values: completed not_found ambiguous unsupported unavailable
source
required
Any of:
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
reason
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
credential_assertions
required
Array<object>

Customer-safe registry-backed credential assertion derived from a document or lookup.

object
scheme_code
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
definition_code
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
source
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
status
required
minLength(1)

A string at least 1 character(s) long

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

A string at least 1 character(s) long

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

A string at least 1 character(s) long

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

A string at least 1 character(s) long

string
>= 1 characters
valid_until
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
fraud_signals
required
Array<object>

Machine-readable fraud signal 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
findings
required
Array<object>

Public intrinsic Finding produced from this document alone.

object
id
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
code
required
string
Allowed values: document.intrinsic_issue
scope
required
string
Allowed values: document
impact
required
string
Allowed values: informational review_required non_compliant
title
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
explanation
required
minLength(1)

A string at least 1 character(s) long

string
>= 1 characters
document_ids
required
Array<string>
requirement_codes
required
Array<string>
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
Example 
{
  "object": "single",
  "data": {
    "object": "document",
    "id": "doc_example1042",
    "workspace_id": "wsp_example1042",
    "assessment_id": null,
    "status": "uploaded",
    "document_result": null,
    "filename": "passport.pdf",
    "classified_as": null,
    "facts": {},
    "verifications": [],
    "enrichment": {
      "status": "pending",
      "checks": [],
      "issues": []
    },
    "credential_assertions": [],
    "issues": [],
    "fraud_signals": [],
    "findings": [],
    "uploaded_at": "2026-08-23T09:30:00Z",
    "completed_at": null
  }
}

400

Section titled “400 ”

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"
}

401

Section titled “401 ”

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"
}

403

Section titled “403 ”

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"
}

404

Section titled “404 ”

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"
}

409

Section titled “409 ”

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"
}

422

Section titled “422 ”

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."
      }
    ]
  }
}

429

Section titled “429 ”

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"
}

500

Section titled “500 ”

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"
}