Skip to main content

Update a document​

Update a document by its ID

Path Parameters
  • document_id string required

    Document ID

Query Parameters
  • key string required
Request Body required
  • action object
    • type string required

      Possible values: [approve, delete, bounce]

      Action to perform on the document

Responses

Document

Schema
  • document_id string required

    A unique identifier assigned by Paperbox to every processed document.

  • web_url string

    A link to access a document or resource in the Paperbox system via the user interface (UI).

  • provider_document_id string

    An identifier set by the customer or third-party provider to track the document externally.

  • active boolean required

    The current status of the document in Paperbox, specifying whether it has been processed or not.

  • inbox_id string

    Inbox ID

  • action object
    • type string required

      Possible values: [approve, delete, bounce]

      Action that was performed on the document

    • actor_id string required

      The unique identifier of the user who performed the action.

    • timestamp string required

      Timestamp of the action

    • metadata object[]

      Additional metadata on the performed 'bounce' or 'delete' action. Empty when the document is approved.

      • type string required
      • value required
  • doc_type_id string

    Document type ID (set by classification)

  • doc_subtype_id string

    Document subtype ID (set by classification)

  • confidence number

    Possible values: value ≤ 1

    Confidence of the classification of the document

  • tag_type_id string
  • entities object[]

    Entities extracted from the document

    • id string

      Entity ID (internal use only)

    • type string

      The entity type as extracted by Paperbox, as defined in the inbox settings.

    • value

      The entity value as processed by Paperbox

    • raw_value

      The original value as it appears in the document before any adjustments.

    • confidence number

      Possible values: value ≤ 1

      The confidence score indicating the reliability of the detected entity.

    • ocr_confidence number

      Possible values: value ≤ 1

      The confidence score assigned to the entity by OCR (Optical Character Recognition)

  • metadata object

    Metadata

    • table object

      Table metadata

    • provider object

      Provider metadata

  • upload_time string required

    The timestamp the document was received by Paperbox

  • available_time string

    The timestamp the document became available in the Paperbox user interface