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

# Get document signature URL

> Generate an embedded signing URL for a specific signature on a document, suitable for loading in an iframe.

Only available for signatures created in **embedded signing mode** (`request.is_embedded: true` on the document's signatory record). Embedded mode is an account-level configuration — all signatures of a request share it. Requesting a URL for an unknown `signature_id` or a non-embedded signature returns a `500` with the error message (e.g. `Signature url is only available in embedded mode: …`).

Embedded URLs are short-lived; generate one immediately before presenting the signing UI rather than storing it.



## OpenAPI

````yaml /api-reference/endpoint/documents/openapi.json get /file-generator/documents/{key}/signature-url
openapi: 3.1.0
info:
  title: Documents API
  description: >-
    Document templates, generated documents, e-signature requests, and checkbox
    approvals. Template and document routes are served under `/file-generator`,
    approval routes under `/workspaces/approvals`.
  version: 1.2.0
servers:
  - url: https://api.quiva.ai
    description: Production API server
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: Templates
    description: >-
      Template lifecycle — create, read, publish, validate, trigger, and delete
      document templates. Templates follow a **draft → published** model: writes
      (`POST`, `PATCH`) always target the draft version, and `POST
      /templates/{key}/publish` promotes the draft. Document generation only
      ever uses the published version, so drafts can be edited safely without
      affecting production output. A template's `source` is a DOCX file
      containing angular-expression tags rendered at trigger time.
  - name: Documents
    description: >-
      Document lifecycle — read, update, and delete generated documents. A
      document record is created immediately when a template is triggered and is
      updated asynchronously: first with the generated `output.key` (an `obj://`
      or `kv://` storage URI) or `errors`, then with `signatures` progress as
      signatories sign.
  - name: Signatures
    description: >-
      E-signature workflows powered by HelloSign (Dropbox Sign). Signature
      requests are created automatically when a triggered template defines
      `signatories`. Each signatory tracks a status lifecycle of `DRAFT → SENT →
      SIGNED`, with `EXPIRED` (validity window elapsed) and `FAILED`
      (delivery/signing error) as terminal failure states. Embedded signing URLs
      can be generated for signatures created in embedded mode.
  - name: Approvals
    description: Checkbox approval of a workspace file, recorded as e-signature evidence.
  - name: Generation
  - name: Template Source
paths:
  /file-generator/documents/{key}/signature-url:
    get:
      tags:
        - Signatures
      summary: Get document signature URL
      description: >-
        Generate an embedded signing URL for a specific signature on a document,
        suitable for loading in an iframe.


        Only available for signatures created in **embedded signing mode**
        (`request.is_embedded: true` on the document's signatory record).
        Embedded mode is an account-level configuration — all signatures of a
        request share it. Requesting a URL for an unknown `signature_id` or a
        non-embedded signature returns a `500` with the error message (e.g.
        `Signature url is only available in embedded mode: …`).


        Embedded URLs are short-lived; generate one immediately before
        presenting the signing UI rather than storing it.
      operationId: getDocumentSignatureUrl
      parameters:
        - $ref: '#/components/parameters/DocumentKey'
        - name: signature_id
          in: query
          required: true
          description: HelloSign signature ID.
          schema:
            type: string
            example: hs_sig_xyz789
      responses:
        '200':
          description: >-
            Embedded signing URL generated successfully. Load this URL with the
            HelloSign embedded JS client; it expires shortly after creation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SignatureUrlResponse'
              example:
                signature_url: >-
                  https://app.hellosign.com/sign/abc123?client_id=cid_xyz&skip_domain_verification=true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    DocumentKey:
      name: key
      in: path
      required: true
      description: Unique document key, typically a file path.
      schema:
        type: string
        example: contracts/acme-nda-2024.docx
  schemas:
    SignatureUrlResponse:
      type: object
      properties:
        signature_url:
          type: string
          format: uri
          description: >-
            Embedded HelloSign signing URL, with `client_id` and
            `skip_domain_verification=true` already appended. Returned as
            snake_case `signature_url` at the gateway.
          example: >-
            https://app.hellosign.com/sign/abc123?client_id=cid_xyz&skip_domain_verification=true
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          example: '"key" is required'
  responses:
    BadRequest:
      description: Invalid or missing request parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: '"key" is required'
    Unauthorized:
      description: Missing or invalid Authorization header.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Authorization header with a bearer token is required
    ServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: server error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.