> ## 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.

# Récupérer une Demande de Signature

> Récupérer une demande de signature spécifique par ID



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.fr.json get /signing-requests/{id}
openapi: 3.0.3
info:
  title: API Partenaire Firma
  description: >-
    API RESTful pour la signature de documents et la gestion de modèles.


    **Authentification** : Tous les endpoints nécessitent une authentification
    par clé API via l'en-tête `Authorization`. Utilisez votre clé API
    directement sans préfixe (par exemple, `your-api-key`). Le préfixe Bearer
    est optionnel mais pas obligatoire.


    **Fonctionnalités de sécurité** :

    - Validation des entrées avec des schémas Zod incluant des messages d'erreur
    détaillés au niveau des champs

    - Jetons JWT signés RSA-256 pour l'accès aux modèles intégrés


    **Limitation de débit** : Les limites de débit sont hiérarchisées selon le
    type d'opération :

    - Opérations de lecture (GET) : 200 requêtes par minute

    - Opérations d'écriture (POST/PUT/PATCH/DELETE) : 120 requêtes par minute

    - Opérations CRUD sur les webhooks : 60 requêtes par minute

    - Test de webhook : 10 requêtes par minute

    - Régénération/expiration de clé API : 1 requête par minute

    - Rotation du secret de webhook : 1 requête par minute


    Lorsque les limites de débit sont dépassées, l'API renvoie une réponse `429
    Too Many Requests` avec les en-têtes suivants :

    - `X-RateLimit-Limit` : Nombre maximal de requêtes par minute pour cet
    endpoint

    - `X-RateLimit-Remaining` : Requêtes restantes dans la fenêtre actuelle

    - `X-RateLimit-Reset` : Horodatage Unix de la réinitialisation de la limite

    - `Retry-After` : Secondes à attendre avant de pouvoir réessayer


    **Gestion des erreurs** : Toutes les erreurs renvoient des réponses JSON
    structurées avec `error` (message lisible par un humain), `code`
    (identifiant lisible par une machine) et `details` (erreurs de validation au
    niveau des champs, le cas échéant).


    **Intégration de l'Éditeur de Modèles intégré** : L'Éditeur de Modèles Firma
    peut être intégré dans votre application à l'aide d'une bibliothèque
    JavaScript autonome.


    ```html

    <!-- Charger la bibliothèque de l'Éditeur de Modèles Firma -->

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


    <script>

    // Générer d'abord un jeton JWT via l'API

    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 => {
      // Initialiser l'éditeur avec le jeton JWT
      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);
        }
      });
    });

    </script>

    ```
  version: 01.30.00
  contact:
    name: API Support
    url: https://firma.com/support
servers:
  - url: https://api.firma.dev/functions/v1/signing-request-api
    description: API de Production - Recommandée (Actuelle)
  - url: https://api.firma.dev/api/v1
    description: API de Production - Prévue
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Informations et paramètres de l'entreprise
  - name: Workspaces
    description: Opérations de gestion des Espaces de Travail
  - name: Templates
    description: Opérations de gestion des Modèles
  - name: Signing Requests
    description: Opérations de Demande de Signature de documents
  - name: Custom Fields
    description: >-
      Gestion des définitions de champs personnalisés pour les espaces de
      travail, modèles et demandes de signature
  - name: Webhooks
    description: Configuration et gestion des webhooks
  - name: JWT Management
    description: Génération et révocation de jetons JWT pour les modèles intégrés
  - name: Workspace Settings
    description: Configuration et paramètres de l'espace de travail
  - name: Email Domains
    description: >-
      Configuration et vérification de domaine e-mail pour l'envoi d'e-mails de
      demande de signature depuis des domaines personnalisés
  - name: Email Templates
    description: >-
      Gestion des modèles d'e-mail pour la personnalisation des notifications de
      demande de signature au niveau de l'espace de travail et de l'entreprise
  - name: Signer Terms
    description: >-
      Conditions d'utilisation / déclarations de consentement personnalisées
      pour le signataire, au niveau de l'entreprise avec des surcharges par
      espace de travail et par langue
paths:
  /signing-requests/{id}:
    get:
      tags:
        - Signing Requests
      summary: Récupérer une Demande de Signature
      description: Récupérer une demande de signature spécifique par ID
      operationId: getSigningRequest
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Demande de signature récupérée avec succès. Renvoie une structure
            imbriquée détaillée avec le statut sous forme d'objet et les
            horodatages regroupés ensemble.
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Limite de débit : 200 requêtes par minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningRequestDetail'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: TypeScript
          label: '@firma-dev/sdk'
          source: |-
            import { FirmaClient } from "@firma-dev/sdk";

            const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

            const response = await firma.signingRequests.getSigningRequest({
                id: "id"
            });
            console.log(response);
components:
  schemas:
    SigningRequestDetail:
      type: object
      description: >-
        Demande de Signature détaillée telle que renvoyée par GET
        /signing-requests/{id} (structure imbriquée avec un objet status et des
        horodatages)
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique de la demande de signature
        name:
          type: string
          description: Nom de la demande de signature
        template_description:
          type: string
          nullable: true
          description: Description issue du modèle
        companies_workspaces_id:
          type: string
          format: uuid
          description: >-
            ID de l'espace de travail auquel appartient cette demande de
            signature
        document_url:
          type: string
          format: uri
          description: URL pré-signée vers le document PDF
        document_url_expires_at:
          type: string
          format: date-time
          nullable: true
        document_page_count:
          type: integer
          minimum: 1
          description: Nombre de pages du document
        expiration_hours:
          type: integer
          description: Nombre d'heures avant l'expiration de la demande de signature
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Horodatage ISO 8601 correspondant à l'expiration de la demande de
            signature. Calculé à partir de sent_on + expiration_hours. Null si
            elle n'a pas encore été envoyée ou si aucun expiration_hours n'est
            défini.
        credit_cost:
          type: integer
          description: Crédits consommés lors de l'envoi
        status:
          type: object
          description: >-
            Indicateurs de statut (plusieurs peuvent être vrais pour les états
            terminaux)
          properties:
            sent:
              type: boolean
            finished:
              type: boolean
            cancelled:
              type: boolean
            declined:
              type: boolean
            expired:
              type: boolean
        timestamps:
          type: object
          description: >-
            Tous les horodatages pertinents pour le cycle de vie de la demande
            de signature
          properties:
            created_on:
              type: string
              format: date-time
            sent_on:
              type: string
              format: date-time
              nullable: true
            finished_on:
              type: string
              format: date-time
              nullable: true
            cancelled_on:
              type: string
              format: date-time
              nullable: true
            declined_on:
              type: string
              format: date-time
              nullable: true
            last_changed_on:
              type: string
              format: date-time
            last_signing_action_on:
              type: string
              format: date-time
              nullable: true
        settings:
          $ref: '#/components/schemas/SigningRequestSettings'
        use_signing_order:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        allow_download:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        allow_editing_before_sending:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        hand_drawn_only:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        attach_pdf_on_finish:
          type: integer
          enum:
            - 0
            - 1
          deprecated: true
        certificate:
          type: object
          nullable: true
          description: Informations sur le statut de génération du certificat
          properties:
            generated:
              type: boolean
              description: Indique si le certificat PDF final a été généré
            generated_on:
              type: string
              format: date-time
              nullable: true
              description: Horodatage de la génération du certificat
            has_error:
              type: boolean
              description: >-
                Indique s'il y a eu une erreur lors de la génération du
                certificat
        final_document_download_url:
          type: string
          format: uri
          nullable: true
          description: >-
            URL signée pour télécharger le document final signé (PDF avec
            certificat). L'URL expire après 1 heure.
        final_document_download_error:
          type: string
          nullable: true
          enum:
            - file_not_accessible
            - null
        document_only_download_url:
          type: string
          format: uri
          nullable: true
          description: >-
            URL signée pour télécharger le PDF du document seul. L'URL expire
            après 1 heure.
        document_only_download_error:
          type: string
          nullable: true
          enum:
            - file_not_accessible
            - null
        certificate_only_download_url:
          type: string
          format: uri
          nullable: true
          description: >-
            URL signée pour télécharger le PDF du certificat seul. L'URL expire
            après 1 heure.
        certificate_only_download_error:
          type: string
          nullable: true
          enum:
            - file_not_accessible
            - null
      required:
        - id
        - name
        - status
        - companies_workspaces_id
    SigningRequestSettings:
      type: object
      description: >-
        Paramètres renvoyés par les endpoints de liste et de détail des demandes
        de signature. Les modèles utilisent le schéma TemplateSettings (sans
        champs d'identité).
      properties:
        allow_download:
          type: boolean
          description: Indique si les destinataires peuvent télécharger le document
          default: true
        attach_pdf_on_finish:
          type: boolean
          description: Indique s'il faut joindre le PDF une fois la signature terminée
          default: true
        allow_editing_before_sending:
          type: boolean
          description: Indique si la demande de signature peut être modifiée avant l'envoi
          default: false
        use_signing_order:
          type: boolean
          description: >-
            Indique si l'ordre de signature est imposé entre les destinataires.
            Quand c'est vrai, les signataires reçoivent le document dans l'ordre
            défini par leur order. Quand c'est faux, tous les signataires
            reçoivent le document simultanément.
          default: true
        hand_drawn_only:
          type: boolean
          description: >-
            Lorsque cette option est activée, les signataires ne peuvent que
            dessiner leur signature à la main et ne peuvent pas utiliser de
            signatures dactylographiées
          default: false
        send_signing_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer des e-mails de notification de demande de
            signature aux signataires
          default: true
        send_finish_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer un e-mail de fin lorsque tous les
            signataires ont terminé
          default: true
        send_expiration_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer un e-mail de notification d'expiration
            quand la demande expire
          default: true
        send_cancellation_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer un e-mail de notification d'annulation
            quand la demande est annulée
          default: true
        require_otp_verification:
          type: boolean
          nullable: true
          description: >-
            Indique si les signataires doivent vérifier leur e-mail avec un code
            à usage unique avant d'accéder au document. null = hérite du
            paramètre de l'espace de travail/de l'entreprise.
          default: null
        disable_guided_navigation:
          type: boolean
          nullable: true
          description: >-
            Désactive le défilement automatique vers le prochain champ requis
            pendant la signature. Hérite de l'espace de travail ou de
            l'entreprise si non défini.
        allow_presigning_download:
          type: boolean
          nullable: true
          description: >-
            Permet aux signataires de télécharger le document original avant de
            signer. Hérite du paramètre de l'espace de travail ou de
            l'entreprise quand null.
        show_qr_code:
          type: boolean
          nullable: true
          description: >-
            Affiche un QR code sur la page de signature qui permet aux
            signataires de continuer sur leur téléphone. Hérite du paramètre de
            l'espace de travail ou de l'entreprise quand null.
        identity_editable_fields:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Champs d'identité que les signataires peuvent modifier avant de
            signer (par exemple ["name", "company"]). null = désactivé. Quand
            c'est défini, une boîte de dialogue de confirmation permet aux
            signataires de modifier les champs spécifiés.
        notify_identity_change_email:
          type: boolean
          default: false
          description: >-
            Envoie une notification par e-mail quand un signataire modifie son
            identité.
    Error:
      type: object
      properties:
        error:
          type: string
          description: Message d'erreur lisible par un humain
        message:
          type: string
          description: Description détaillée de l'erreur
        details:
          type: object
          description: Détails d'erreur supplémentaires
          additionalProperties: true
      required:
        - error
  responses:
    UnauthorizedError:
      description: Non Autorisé - Clé API invalide ou manquante
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    NotFoundError:
      description: Non Trouvé - La ressource n'existe pas
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource was not found
    RateLimitError:
      description: Trop de requêtes - Limite de débit dépassée
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Nombre maximum de requêtes par minute
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requêtes restantes
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Timestamp Unix de la réinitialisation
        Retry-After:
          schema:
            type: integer
          description: Secondes avant de pouvoir réessayer
      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: >-
        Clé API pour l'authentification. Utilisez votre clé API directement sans
        préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel
        mais pas obligatoire.

````