Skip to main content
POST
@firma-dev/sdk

Autorisations

Authorization
string
header
requis

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.

Corps

application/json

Créer une Demande de Signature à partir d'un document PDF

document
string<byte>
requis

Document PDF ou DOCX encodé en base64. Les fichiers DOCX sont automatiquement convertis en PDF. Le nombre de pages est extrait automatiquement. Pour les documents de plus de 5 Mo, utilisez POST /documents et transmettez le document_id à la place.

name
string

Nom de la Demande de Signature

Maximum string length: 255
description
string

Description de la Demande de Signature

expiration_hours
integer
défaut:168

Nombre d'heures avant l'expiration de la Demande de Signature (par défaut : 168 = 7 jours)

Plage requise: x >= 1
recipients
object[]

Destinataires de la Demande de Signature. Utilise des ID temporaires (ex. 'temp_1') dans le champ id pour référencer les destinataires dans fields/reminders.

fields
object[]

Champs à placer sur le document

anchor_tags
object[]

Balises d'ancrage pour le placement automatique des champs. Les marqueurs de texte dans le PDF sont localisés et convertis en champs positionnés. Le texte d'ancrage est supprimé du PDF après traitement. Les champs créés à partir de balises d'ancrage sont ajoutés en plus des champs spécifiés manuellement. Disponible uniquement pour la création basée sur un document (pas basée sur un Modèle).

Maximum array length: 100
reminders
object[]

Rappels à envoyer aux destinataires

settings
object

Paramètres de la Demande de Signature

language
enum<string> | null

Langue facultative des e-mails pour cette demande de signature. Lorsqu'elle est définie, tous les e-mails destinés au signataire (et le format de date) l'utilisent. Omettez-la ou utilisez null pour revenir à la langue par défaut de l'espace de travail, puis de l'entreprise (comportement inchangé).

Options disponibles:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl,
cs,
sv,
nl,
ro,
nb
completion_title
string | null

Titre affiché sur la page de finalisation après la signature. Hérite de l'espace de travail, puis de l'entreprise, lorsqu'il est omis ou null.

Maximum string length: 200
completion_message
string | null

Texte principal affiché sur la page de finalisation après la signature. Hérite de l'espace de travail, puis de l'entreprise, lorsqu'il est omis ou null.

Maximum string length: 1000
completion_redirect_url
string<uri> | null

URL vers laquelle le signataire est redirigé depuis la page de finalisation. Doit utiliser https:// (http://localhost et http://127.0.0.1 sont également acceptés sur les demandes de signature en mode test). Hérite de l'espace de travail, puis de l'entreprise, lorsqu'elle est omise ou null.

Maximum string length: 2000
completion_redirect_delay
integer | null

Secondes d'attente de la page de finalisation avant redirection (0 redirige immédiatement). S'applique uniquement lorsqu'une URL de redirection est résolue ; la page utilise 5 secondes lorsqu'aucun niveau ne définit de délai. Hérite de l'espace de travail, puis de l'entreprise, lorsqu'il est omis ou null.

Plage requise: 0 <= x <= 30
seal_participants
object[]

Participants de cachet d'organisation à inclure dans la séquence de signature

Réponse

Demande de signature créée avec succès. La réponse peut inclure des avertissements non bloquants liés aux e-mails ou aux balises d'ancrage.

Demande de signature telle que renvoyée par les endpoints CREATE (POST /signing-requests)

id
string<uuid>
requis

Identifiant unique de la demande de signature

name
string
requis

Nom de la demande de signature

Maximum string length: 255
status
enum<string>
requis

Le statut est toujours 'draft' pour les demandes de signature nouvellement créées

Options disponibles:
draft
description
string | null

Description de la demande de signature

document_url
string<uri>

URL pré-signée vers le document PDF

page_count
integer

Nombre de pages dans le document

Plage requise: x >= 1
expiration_hours
integer
défaut:168

Nombre d'heures avant l'expiration de la demande de signature (par défaut : 168 = 7 jours)

Plage requise: x >= 1
template_id
string<uuid> | null

ID du modèle si créé à partir d'un modèle

settings
object

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é).

created_date
string<date-time>

Horodatage de création

updated_date
string<date-time>

Horodatage de dernière mise à jour

sent_date
string<date-time> | null

Date d'envoi de la demande de signature

finished_date
string<date-time> | null

Date à laquelle toutes les signatures ont été complétées

cancelled_date
string<date-time> | null

Date d'annulation de la demande de signature

recipients
object[]

Destinataires de la demande de signature

fields
object[]

Champs de la demande de signature avec des valeurs de position à plat

warnings
string[]

Avertissements optionnels non bloquants, incluant des formats d'e-mail de destinataire inhabituels, des propriétés de balise d'ancrage inconnues pendant la fenêtre de compatibilité et des avertissements de traitement des ancrages.

seal_participants
object[]

Participants de cachet d'organisation dans l'ordre de signature. Vide lorsque la demande n'a pas de cachet.