Uploads

Upload an attachment file

Upload an attachment file to include with the documents you send. An uploaded attachment can be reused in many documents, and attachments can have restricted access or require a view or click before the recipient proceeds with the signing.

Use the returned id to assign the attachment to a document.

post/v1/upload/attachment

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/upload/attachment
  • Auth: HTTP bearer

Request body

file_contentstring

Send the file as base64 encoded. Note that base64 encoding files will increase the file size by about 30%

file_urlstring

Url to the file. The file must be available for download without any authorization. It is always downloaded over https://, also when the URL starts with http://.

file_namestring

Filename including the extension, for example terms.pdf. Required with file_url or file_content: without it the upload is rejected with status 0. Optional for a multipart upload, where the multipart file name is used. A file_name without an extension answers 400.

filestring binary

Response

The request succeeded.

status0 | 1 required

Outcome of the upload, 1 when the file was stored and 0 when it was rejected with the reason in error.

errorstring

Reason the upload was rejected, returned only when status is 0.

idstring

Id of the created attachment, used to assign it to a document.

file_idstring

Legacy file id generated for the response, which does not reference the stored attachment.

filenamestring

Name the attachment was stored under, taken from file_name or the multipart file name.

extensionstring

File extension of filename, without the leading dot.

type'file' required

Attachment type of the created attachment, always file for an uploaded file.

Changes

No recorded changes to this operation across all 1 revision of this API.