Document Operations

Store a file in a document's file storage

<small>Requires an API token with the Document Manager role.</small>

POST

/documents/{document}/file-storage

curl --request POST \
  --url https://app.fynk.com/v1/api/documents/{document}/file-storage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "file_name": "NDA_BigCorp.pdf",
  "file_upload_uuid": "d16017e0-f60d-45b6-98cf-b1f41d0747fa"
}
'

{
  "data": {
    "file_name": "NDA_BigCorp.pdf",
    "file_size": 544600,
    "mime_type": "application/pdf",
    "sha256": "697651f6ceea8a931289ff64cb62f78ceea5d36f7e84590fe9d5920b2dce52cf",
    "uuid": "c3f8ca57-b1a4-4560-b3fe-5f3fffb333dd"
  }
}

Associates a previously uploaded file with the document referred to by the URL.

This endpoint requires a three-step upload process:

Generate upload URL: Call the Create document file storage upload URL endpoint to get a presigned upload URL
Upload file: Make a POST request to the returned URL with the specified form fields, followed by the file contents in a file field
Associate uploaded file with document: Call this endpoint with file_upload_uuid set to the uuid received in step 1

The file will be available in the file storage of the document referred to in the URL.

For a complete guide with examples, see How to store a file in a document's file storage.