/files
POST {{base-api-url}}/files
The procedure
parameter is mandatory.
This means that attachment files must be added after the creation of the procedure. You will not be able to add attachments until you have created the signing procedure.
Param | Description |
---|---|
signable | Files that will be signed by the signers. This is the default value. |
attachment | Files that will NOT be signed by the signers (e.g. annex, terms of use, flyers, commercial brochure, and so on). However, they may be consulted by the participants within the signing procedure before signing the other documents. |
Request Body
{"name"=>"Name of my attachment.pdf", "content"=>"JVBERi0xLjUKJb/3ov4KICA[...]VPRgo=", "procedure"=>"/procedures/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX", "type"=>"attachment"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | This value is a secret and needs to be replaced by your API Key (Bearer). | |
Content-Type | string | This header specifies the format of the exchanges in JSON. |
RESPONSES
status: Created
{"id":"/files/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","name":"Name of my attachment.pdf","type":"attachment","contentType":"application/pdf","description":null,"createdAt":"2018-12-01T10:31:56+01:00","updatedAt":"2018-12-01T10:31:56+01:00","sha256":"bb57ae2b2ca6ad0133a699350d1a6f6c8cdfde3cf872cf526585d306e4675cc2","metadata":[],"workspace":"/workspaces/XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX","creator":null,"protected":false,"position":0,"parent":null}