> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firma.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Download Signing Request Document

> Retrieve a download URL for a signing request's signed document. For completed signing requests, returns the final signed PDF. For in-progress signing requests where partial download is enabled, returns a URL to the partially-signed document generated at the time of the last signer's completion.

**Partial downloads:** Partial downloads are only available when the signing request has `allow_partial_download` enabled in settings. If the document has not been partially generated yet, a `503` is returned — retry after the `Retry-After` interval.

**URL expiry:** The `download_url` is a pre-signed URL that expires. The expiry timestamp is provided in `expires_at`.



## OpenAPI

````yaml api-reference/v01.19.00/openapi-v01.19.00.json get /signing-requests/{id}/download
openapi: 3.0.3
info:
  title: Firma Partner API
  description: >-
    RESTful API for document signing and template management.


    **Authentication**: All endpoints require API key authentication via the
    `Authorization` header. Use your API key directly without any prefix (e.g.,
    `your-api-key`). The Bearer prefix is optional but not required.


    **Security Features**:

    - Input validation using Zod schemas with detailed field-level error
    messages

    - RSA-256 signed JWT tokens for embedded template access


    **Rate Limiting**: Rate limits are tiered based on operation type:

    - Read operations (GET): 200 requests per minute

    - Write operations (POST/PUT/PATCH/DELETE): 120 requests per minute

    - Webhook CRUD operations: 60 requests per minute

    - Webhook test: 10 requests per minute

    - API key regeneration/expiration: 1 request per minute

    - Webhook secret rotation: 1 request per minute


    When rate limits are exceeded, the API returns a `429 Too Many Requests`
    response with headers:

    - `X-RateLimit-Limit`: Maximum requests per minute for this endpoint

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when limit resets

    - `Retry-After`: Seconds until retry is allowed


    **Error Handling**: All errors return structured JSON responses with `error`
    (human-readable message), `code` (machine-readable identifier), and
    `details` (field-level validation errors when applicable).


    **Embedded Template Integration**: The Firma Template Editor can be embedded
    in your application using a standalone JavaScript library.


    ```html

    <!-- Load the Firma Template Editor library -->

    <script
    src="https://api.firma.dev/functions/v1/embed-proxy/template-editor.js"></script>


    <script>

    // Generate JWT token via API first

    fetch('https://api.firma.dev/functions/v1/signing-request-api/generate-template-token',
    {
      method: 'POST',
      headers: {
        'Authorization': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        companies_workspaces_templates_id: 'template-id'
      })
    })

    .then(res => res.json())

    .then(data => {
      // Initialize editor with JWT token
      window.FirmaTemplateEditor.init({
        container: '#firma-editor-container',
        jwt: data.token,
        templateId: 'template-id',
        theme: 'dark',
        readOnly: false,
        onSave: (savedData) => {
          console.log('Template saved:', savedData);
        },
        onError: (error) => {
          console.error('Editor error:', error);
        },
        onLoad: (template) => {
          console.log('Template loaded:', template);
        }
      });
    });

    ```
  version: 01.19.00
  contact:
    name: API Support
    url: https://firma.com/support
servers:
  - url: https://api.firma.dev/functions/v1/signing-request-api
    description: Production API - Recommended (Current)
  - url: https://api.firma.dev/api/v1
    description: Production API - Planned
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Company information and settings
  - name: Workspaces
    description: Workspace management operations
  - name: Templates
    description: Template management operations
  - name: Signing Requests
    description: Document signing request operations
  - name: Custom Fields
    description: >-
      Custom field definition management for workspaces, templates, and signing
      requests
  - name: Webhooks
    description: Webhook configuration and management
  - name: JWT Management
    description: JWT token generation and revocation for embedded templates
  - name: Workspace Settings
    description: Workspace configuration and settings
  - name: Email Domains
    description: >-
      Email domain setup and verification for sending signing request emails
      from custom domains
  - name: Email Templates
    description: >-
      Email template management for workspace and company-level customization of
      signing request notifications
  - name: Legacy
    description: Deprecated endpoints maintained for backward compatibility
paths:
  /signing-requests/{id}/download:
    get:
      tags:
        - Signing Requests
      summary: Download Signing Request Document
      description: >-
        Retrieve a download URL for a signing request's signed document. For
        completed signing requests, returns the final signed PDF. For
        in-progress signing requests where partial download is enabled, returns
        a URL to the partially-signed document generated at the time of the last
        signer's completion.


        **Partial downloads:** Partial downloads are only available when the
        signing request has `allow_partial_download` enabled in settings. If the
        document has not been partially generated yet, a `503` is returned —
        retry after the `Retry-After` interval.


        **URL expiry:** The `download_url` is a pre-signed URL that expires. The
        expiry timestamp is provided in `expires_at`.
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Signing request ID
      responses:
        '200':
          description: Download URL retrieved successfully.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Rate limit: 200 requests per minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningRequestDownloadResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          description: Signing request not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
        '409':
          description: >-
            Signing request has not been sent yet. Download is only available
            after the request has been sent.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: no_document_available
                message: Signing request has not been sent yet
        '429':
          $ref: '#/components/responses/RateLimitError'
        '503':
          description: >-
            Document generation is in progress. Retry after the indicated
            interval.
          headers:
            Retry-After:
              schema:
                type: integer
              description: Seconds to wait before retrying
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                generation_timeout:
                  summary: Document generation timed out
                  value:
                    error: generation_timeout
                stale_at_publication:
                  summary: Document was stale at publication time
                  value:
                    error: stale_at_publication
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SigningRequestDownloadResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - finished
            - in_progress
            - cancelled
            - declined
            - expired
          description: >-
            Signing request status. `finished` means all signers have completed.
            `in_progress` means signing is still ongoing and this is a partial
            download. `cancelled`, `declined`, and `expired` indicate terminal
            states where the document is a partial snapshot from the point when
            signing ended.
        is_partial:
          type: boolean
          description: >-
            Whether this download URL points to a partially-signed document (not
            all signers have completed).
        download_url:
          type: string
          format: uri
          description: >-
            Pre-signed URL to download the PDF document. Expires at the time
            indicated by `expires_at`.
        generated_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            ISO 8601 timestamp when the document was last generated. For partial
            downloads, this is when the partial PDF was created.
        expires_at:
          type: string
          format: date-time
          description: >-
            ISO 8601 timestamp when the `download_url` expires. Fetch this
            endpoint again for a fresh URL after expiry.
      required:
        - status
        - is_partial
        - download_url
        - expires_at
    Error:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message
        message:
          type: string
          description: Detailed error description
        details:
          type: object
          description: Additional error details
          additionalProperties: true
  responses:
    UnauthorizedError:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    RateLimitError:
      description: Too Many Requests - Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Maximum requests per minute
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requests remaining
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix timestamp of reset
        Retry-After:
          schema:
            type: integer
          description: Seconds until retry allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate Limit Exceeded
            message: Too many requests. Please wait before retrying.
            details:
              retry_after: 45
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key for authentication. Use your API key directly without any prefix
        (e.g., 'your-api-key'). Bearer prefix is optional but not required.

````