Create document attachment

post

https://app-sandbox.trustpair.com/api/v1/documents/

Creates a new document attachment in the authenticated customer's workspace.

This endpoint allows you to:

Upload document files to your workspace
Associate documents with specific users
Add descriptions to documents for better categorization
Store supporting documentation for overrides or other entities

The uploaded document will be stored securely and can later be attached to overrides or other resources as supporting evidence.

Required permissions:

documents_write

Supported file formats:

PDF (.pdf)
Microsoft Word (.doc, .docx)
Microsoft Excel (.xls, .xlsx)
Images (.jpg, .jpeg, .png)

Maximum file size: 30 MB

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

user_id

string

required

Unique identifier of the user who is uploading the document.

The user must belong to the authenticated customer's workspace. This ID will be used to track who uploaded each document.

file

required

The file content to upload as a document attachment.

Constraints:

Must be one of the supported file formats (PDF, Word, Excel, Images)
Must not exceed the maximum file size (30 MB)
Cannot be an empty file

File content must be provided as binary data in a multipart/form-data request.

description

string

required

A descriptive text for the document that explains its purpose or contents.

This description helps users identify the document's purpose later when viewing or selecting documents in the system.

Headers

Accept-Language

string

enum

Specifies the preferred language for the response. Supported languages:

en - English
fr - French

If not provided, the default language will be used.

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Document created

401Unauthorized response code

403Forbidden response code

422Unprocessable Entity response code