Files

Get a signer attachment

get/documents/{id}/attachments/{attachment_id}

Returns a 5-minute download link for a file a signer uploaded.

Needs a key with documents:read.

Path parameters

idUUIDRequired
The document ID.
attachment_idUUIDRequired
The attachment ID, from the recipient's attachments.

Example request

curl "https://www.inkly.so/api/v1/documents/3f1c2a7e-8b4d-4e21-9a6f-5d0c7e1b2a34/attachments/91c3f5e8-4a07-4d92-8b6e-2f7d1a0c9e35" \
  -H "Authorization: Bearer $INKLY_API_KEY"

Example response, 200

{
  "url": "https://files.example.com/signed/consulting-agreement.pdf?token=example",
  "expires_at": "2026-11-02T15:09:05.123Z",
  "file_name": "Proof of insurance.pdf"
}

Response fields

urlURLRequired
A signed download URL. It works for 5 minutes and needs no API key.
expires_attimestampRequired
file_namestringRequired

Errors specific to this endpoint

unknown_field400This field is not supported.
attachment_not_found404Attachment not found.
document_not_found404Document not found.

Every endpoint can also return the common errors.