UploadDocument

POST

/api/v1/t/{tenant}/documents

curl --request POST \
  --url https://example.com/api/v1/t/example/documents \
  --header 'Authorization: Bearer <token>'

Authorizations

• ApiKey

Parameters

Path Parameters

tenant

required

string

Tenant slug

Responses

201

Created

Media typeapplication/json

object

document

required

object

id

required

string format: uuid

title

required

string

documentTypeId

required

null | string format: uuid

status

required

Allowed values: Processing Active Archived Deleted Purging

metadata

required

isConfidential

required

boolean

processingFailed

required

boolean

isQuarantined

required

boolean

servedVersionNumber

required

null | integer format: int32

currentVersion

required

One of:

null

null

object

object

number

required

integer format: int32

sha256

required

string

size

required

integer format: int64

contentType

required

string

fileName

required

string

createdBy

required

string format: uuid

createdAt

required

string format: date-time

processingState

required

Allowed values: Pending Clean Quarantined Processed Failed

quarantinedAt

required

null | string format: date-time

renditions

required

Array<object>

object

kind

required

Allowed values: PdfA EInvoiceView ValidationReport SignatureProtocol SignatureAuditTrail

generation

required

integer format: int32

contentType

required

string

size

required

integer format: int64

createdAt

required

string format: date-time

recognitionStartedAt

required

null | string format: date-time

endedWithoutPdfA

required

boolean

lockedBy

required

null | string format: uuid

lockedAt

required

null | string format: date-time

fileIds

required

Array<string>

tagIds

required

Array<string>

accessLevel

required

Allowed values: Read Write Manage

createdBy

required

string format: uuid

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

typeSource

required

One of:

null

null

object

object

source

required

Allowed values: Person EInvoice Ai Workflow Computed

resultId

null | string format: uuid

metadataSources

required

object

key

additional properties

object

source

required

Allowed values: Person EInvoice Ai Workflow Computed

resultId

null | string format: uuid

split

One of:

null

null

object

object

splitAt

required

null | string format: date-time

partCount

required

null | integer format: int32

partDocumentIds

required

Array<string>

splitFromDocumentId

required

null | string format: uuid

partNumber

required

null | integer format: int32

firstPage

required

null | integer format: int32

lastPage

required

null | integer format: int32

retentionUntil

null | string format: date

legalHold

boolean

retentionApplies

boolean

retentionStale

boolean

provenance

One of:

null

null

object

object

source

required

Allowed values: Upload Email Api Import

sender

null | string

subject

null | string

messageId

null | string

receivedOn

null | string format: date

duplicates

required

Array<object>

object

documentId

required

string format: uuid

title

required

string

versionNumber

required

integer format: int32

Example

{
  "document": {
    "status": "Processing",
    "currentVersion": {
      "processingState": "Pending",
      "renditions": [
        {
          "kind": "PdfA"
        }
      ]
    },
    "accessLevel": "Read",
    "typeSource": {
      "source": "Person"
    },
    "metadataSources": {
      "additionalProperty": {
        "source": "Person"
      }
    },
    "legalHold": false,
    "retentionApplies": false,
    "retentionStale": false,
    "provenance": {
      "source": "Upload"
    }
  }
}

400

Bad Request

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Forbidden

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

409

Conflict

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

413

Payload Too Large

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

415

Unsupported Media Type

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Too Many Requests

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}