Create a staged document upload handle
POST/v1/sign/uploads
Initializes a direct document upload handle for large agreements and templates.
Upload Flow
- Call this endpoint with the document's
contentTypeand optionalsizeBytesto receive anuploadUrlanduploadId. - Issue an HTTP
PUTrequest directly touploadUrlwith the binary document payload and the returnedheaders. The signed URL expires after 15 minutes. - Reference the returned
uploadIdasdocumentUploadIdwhen creating an agreement (POST /v1/sign/agreements), uploading a document to an agreement (POST /v1/sign/agreements/{agreementId}/documents), or creating/importing a template (POST /v1/sign/templates/POST /v1/sign/templates/import). Staged uploads remain valid for 24 hours.
Request
Responses
- 201
- 400
- 401
- 403
Staged upload handle created successfully
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Directives to prevent caching of signed upload URLs
Invalid request body or unsupported content type
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Unauthorized
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.
Forbidden - token lacks required sign:write scope
Response Headers
Correlation id for this request, returned on every response (success and error). Quote it when contacting support to pinpoint the exact request, and use it to correlate your own logs. It is the same 128-bit id as the trace-id segment of the traceparent header.
W3C Trace Context identifier for this request, returned on every response. Send your own traceparent on a request to have it adopted, so a multi-call workflow shares one trace. Format: 00-<32-hex trace-id>-<16-hex span-id>-<2-hex flags>.