Operations
Create an upload
Upload a PDF, DOCX, or PNG file to SignatureAPI and get back a URL to use as a document source.
Upload a file to SignatureAPI for use as a document source in an envelope. Send the raw file bytes in the request body with the appropriate Content-Type header.
The response includes a url property. Pass this value as the url property of a document when creating an envelope:
// POST https://api.signatureapi.com/v1/envelopes
// X-API-Key: key_test_...
// Content-Type: application/json
{
"documents": [
{
"url": "https://api.signatureapi.com/v1/uploads/upl_1sAAaVfabdt0esVjmSTmLA",
//...
}
],
//...
}
Uploads created through this endpoint are temporary and expire 24 hours after creation. To store a file permanently for reuse across multiple envelopes, use the Store Upload endpoint or upload it to your Library in the dashboard.
The Create Upload endpoint replaces the Create File endpoint. The File resource is soft-deprecated but remains available for backward compatibility.
Request
Send the raw file bytes as the request body. Set the Content-Type header to match the file format.
| Content-Type | Format |
|---|---|
application/pdf | pdf |
application/vnd.openxmlformats-officedocument.wordprocessingml.document | docx |
image/png | png |
Maximum file size: 5 MB (5,242,880 bytes).
Returns
Returns a 201 Created status code and an upload object on success, or an error otherwise.