Skip to content

Attachments

Attachments are supplementary files added to a document. They are sent along with the document but don’t require signatures.

  • Maximum 5 attachments per document
  • Maximum 10 MB per file
  • Allowed types: PDF, JPG, PNG, WebP
  • Images are automatically converted to PDF
GET /api/v1/documents/{id}/attachments

Required scope: documents.read

Terminal window
curl -X GET https://app.insigner.co/api/v1/documents/cm5x9abc123/attachments \
-H "Authorization: Bearer isk_YOUR_API_KEY"

Response

{
"data": [
{
"id": "att_abc123",
"fileName": "terms-and-conditions.pdf",
"fileSize": 524288,
"mimeType": "application/pdf",
"order": 0,
"createdAt": "2026-05-28T12:00:00.000Z"
}
]
}

POST /api/v1/documents/{id}/attachments

Uploads a file as a multipart/form-data request. The document must be in draft status.

Required scope: documents.write

Terminal window
curl -X POST https://app.insigner.co/api/v1/documents/cm5x9abc123/attachments \
-H "Authorization: Bearer isk_YOUR_API_KEY" \
-F "file=@terms-and-conditions.pdf"

Response 201 Created

{
"data": {
"id": "att_abc123",
"fileName": "terms-and-conditions.pdf",
"fileSize": 524288,
"mimeType": "application/pdf",
"order": 0,
"createdAt": "2026-05-28T12:00:00.000Z"
}
}

DELETE /api/v1/documents/{id}/attachments/{attId}

Removes an attachment from a draft document and deletes the file from storage.

Required scope: documents.write

Terminal window
curl -X DELETE https://app.insigner.co/api/v1/documents/cm5x9abc123/attachments/att_abc123 \
-H "Authorization: Bearer isk_YOUR_API_KEY"

Response: 204 No Content