Download signed contract document
Streams the completed (signed) PDF for a contract request through
UrbanPay. Returns
404 if the request does not exist, and 409 if it has not reached
COMPLETED status yet.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Downloads the completed (signed) PDF for a contract request. We stream the file back through our own infrastructure, so the underlying signing-service URL is never exposed to the caller. The contract request must already be completed before its document is available.
Authentication & access
- Requires a client API token:
Authorization: Bearer <token>. - API credentials need the
contracts.requests.readpermission. Dashboard users need the OWNER, OPERATIONS or DEVELOPER role, or a custom role that includes this permission. - Contract signing must be enabled for the client. If it is disabled the request returns
403.
Path parameters
| Parameter | In | Description |
|---|---|---|
request_id | path | The ID of the contract request whose signed document you want to download. Must belong to your client. |
Preconditions
The contract request must be in the completed state (all signers have finished). A request that is still in progress, or that has no associated completed submission, returns 409.
Response
200 - Returns the signed contract document as a binary PDF stream. The response is served with Content-Disposition: inline; filename="<template name> - signed.pdf", where the name comes from the contract template (without a .pdf/.docx extension, characters not allowed in file names replaced, at most 100 characters). If the template has no usable name, or the name cannot be sent in the header, the filename falls back to contract-<request_id> - signed.pdf. The content type comes from the signing service and is normally application/pdf.
Error responses
| Status | When |
|---|---|
403 | Contract signing is disabled for the client |
404 | No contract request with this request_id exists under your client |
409 | The contract is not completed yet (request is not in completed status, or has no completed document) |
502 | The signed document is not yet available from the signing service, or fetching it failed |
503 | The signing service is temporarily unavailable or not configured, please retry later |
Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.