Documents

Confirm Document Upload

Changed on

After you got the temporary file URL of type UPLOAD_URL and the file is uploaded, the upload of file must be confirmed.

post/business/v2/documents/confirm

Request

Request body application/x-www-form-urlencoded

content_typestring required

The MIME type of the Document.

attachment_namestring required

Attachment name of the Document

attachment_typestring

The type of file of the Document.

uploaded_bystring

The User or system that uploaded the file of the Document

thumbnails_sizestring

The requested thumbnail size hint for downstream rendering of file of the Document .

readonlyboolean

Readonly flag of the Document

analysis_requiredboolean

It indicates whether automated content analysis should be performed on the Document after upload.

Example request

{
  "content_type": "application/pdf",
  "attachment_name": "1779089463912.pdf",
  "attachment_type": "RECEIPT",
  "uploaded_by": "USER",
  "thumbnails_size": "x1"
}

Response

The returned resource is a single Document.

idstring

The Document ID.

namestring

The original file name of the Document.

preview_urlstring

Pre-signed URL for the Document preview rendering.

thumbnail_urlstring

The Pre-signed URL for the file of the Document thumbnail.

creation_timestring

The date and time when the Document was imported.

attachedboolean

It indicates whether the Document is already attached to one or more activities.

Example response

{
  "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
  "name": "invoice-2025-001.pdf",
  "preview_url": "https://storage.example.com/documents/7bf79328-a7ae-4222-aa54-091ff7f429a7/preview?signature=...",
  "thumbnail_url": "https://storage.example.com/documents/7bf79328-a7ae-4222-aa54-091ff7f429a7/thumbnail?signature=...",
  "creation_time": "2025-04-12T10:15:30Z"
}

Changes