Sign in
Documents

Retrieve a document

Returns the details of a single document on your account, including its metadata.

get/documents/{id}

Path parameters

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

Identifies the resource.

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

Changes

Changed in 2 of the 61 revisions of this API.4

  • 1571b0380bd72See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379942See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog