Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Documents

Update a document

Update a document.

patch/documents/{id}

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the resource.

Request body

created_atstring

ISO 8601 formatted date-time indicating when the resource was created.

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

updated_atstring

ISO 8601 formatted date-time indicating when the resource was updated.

av_scan_status'scanned' | 'infected' | 'pending_scan' | 'not_scanned'

The antivirus scan status of the document.

content_typestring

The document's content_type.

customer_referencestring

Optional reference string for customer tracking.

filenamestring

The filename of the document.

sha256string

The document's SHA256 hash provided for optional verification purposes.

status'pending' | 'verified' | 'denied'

Indicates the current document reviewing status

Example request

{
  "created_at": "2018-02-02T22:25:27.521Z",
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "document",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "av_scan_status": "scanned",
  "content_type": "application/pdf",
  "customer_reference": "MY REF 001",
  "filename": "test-document.pdf",
  "sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
  "size": {
    "amount": 123456,
    "unit": "bytes"
  },
  "status": "pending"
}

Response

Successful response

Example response

{
  "data": {
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "document",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "av_scan_status": "scanned",
    "content_type": "application/pdf",
    "customer_reference": "MY REF 001",
    "filename": "test-document.pdf",
    "sha256": "08a96c641c3a74e44eb59afb61a24f2cb9f4d7188748e76ba4bb5edfa3cb7d1c",
    "size": {
      "amount": 123456,
      "unit": "bytes"
    },
    "status": "pending"
  }
}