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 type

Responses

Document

Schema
  • document_id string required

    Document id

  • provider_document_id string

    Provider document id

  • active boolean required

    Whether the document is active or not

  • inbox_id string

    Inbox id

  • router_id string

    Router id

  • action object
    • type string required

      Possible values: [approve, delete, bounce]

      Action type

    • actor_id string required

      Actor id

    • timestamp string required

      Timestamp of the action

    • metadata object[]
      • type string required
      • value required
  • doc_type_id string

    Document type id

  • doc_subtype_id string

    Document subtype id

  • confidence number

    Possible values: value ≤ 1

    Confidence of the document

  • entities object[]

    Entities

    • id string

      Entity id

    • type string

      Entity type

    • value string

      Entity value

    • raw_value string

      Raw entity value

    • confidence number

      Possible values: value ≤ 1

      Confidence of the entity

    • ocr_confidence number

      Possible values: value ≤ 1

      Confidence of the entity from OCR

    • source string

      Possible values: [paperbox, user, masterdata, null]

      Source of the entity

  • upload_time string required

    Upload time