Documentation API

Le cycle est simple : votre système crée un document avec le PDF et les informations du signataire, la plateforme renvoie un lien de signature sécurisé. Le signataire l'ouvre, consent explicitement et dessine sa signature. Le document est alors scellé et un webhook notifie votre système.

Chaque document reçoit un identifiant de la forme SSF-2026-000154 (préfixe, année, numéro séquentiel).

Toutes les requêtes vers /api/v1/* exigent une clé API dans l'en-tête Authorization. Générez vos clés depuis l'onglet Clés APIde l'administration. Une clé n'est affichée qu'une seule fois et stockée hachée côté serveur.

Authorization: Bearer ssf_a1b2c3d4e5f6…

Une clé manquante ou invalide renvoie une réponse 401 Unauthorized.

Corps en multipart/form-data. Crée une demande de signature et renvoie le lien à transmettre au signataire (ou envoyé automatiquement par email si le SMTP est configuré).

curl -X POST https://votre-domaine/api/v1/documents \
  -H "Authorization: Bearer ssf_…" \
  -F "file=@contrat.pdf;type=application/pdf" \
  -F "signer_name=Jean Dupont" \
  -F "signer_email=jean@exemple.com" \
  -F "title=Contrat de prestation" \
  -F "expires_in_days=7" \
  -F "callback_url=https://mon-site.com/webhooks/ssf"

{
  "id": "SSF-2026-000154",
  "status": "pending",
  "signing_url": "https://votre-domaine/sign/<token>",
  "verify_url": "https://votre-domaine/verify/SSF-2026-000154",
  "sha256_original": "8e292f…",
  "email_sent": false
}

Renvoie le statut et les métadonnées d'audit. Une fois le document signé, le bloc certificate reprend exactement les champs du certificat joint au PDF.

{
  "id": "SSF-2026-000154",
  "status": "signed",
  "signer": { "name": "Jean Dupont", "email_verified": true },
  "signed_at": "2026-07-03T11:42:00.000Z",
  "modified_after_signature": false,
  "certificate": {
    "Document ID": "SSF-2026-000154",
    "Signataire": "Jean Dupont",
    "Email vérifié": "Oui",
    "Date de signature": "03/07/2026 à 11:42",
    "Méthode": "lien sécurisé envoyé par email",
    "Empreinte SHA-256": "94f6a2…",
    "Adresse IP": "enregistrée",
    "Consentement explicite": "Oui",
    "Document modifié après signature": "Non"
  }
}

Renvoie le fichier PDF (application/pdf) — le document signé avec sa page de certificat, ou l'original si la signature est encore en attente.

Annule une demande en attente. Un document déjà signé ne peut pas être annulé (réponse 409 Conflict).

Recalcule l'empreinte SHA-256 du fichier archivé et la compare à celle enregistrée à la signature. Le champ modified_after_signature vaut false si le document est intact.

{
  "id": "SSF-2026-000154",
  "status": "signed",
  "modified_after_signature": false,
  "Document modifié après signature": "Non"
}

Si vous fournissez callback_url à la création, la plateforme envoie une requête POSTà la signature du document (avec une nouvelle tentative après 5 secondes en cas d'échec).

{
  "event": "document.signed",
  "document": { /* mêmes champs que GET /documents/{id} */ }
}

Trois empreintes accompagnent chaque document, chacune avec un rôle précis :

Les erreurs renvoient un objet { "error": "...", "message": "..." } avec le statut HTTP correspondant.