Aller au contenu
Documentation

Relier les fiches par vos propres identifiants

Décrire documents, participants et emplacements de signature avec vos identifiants, et retrouver ceux du parcours créé.

2 min de lecture Mise à jour le 9 novembre 2026

Pour décrire un parcours d'un bloc, vous pouvez donner un Id de votre choix — un GUID — à chaque document et à chaque participant, et relier par eux les emplacements de signature, à la racine du JSON :

cURL
curl -X POST "https://staging-api.docage.com/Transactions/CreateFullTransaction" \
  -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9…" \
  -F 'Transaction={
    "Name": "Contrat avec Atelier Lumière",
    "ExternalId": "DOSSIER-2026-0042",
    "TransactionFiles": [
      { "Id": "11111111-0000-4000-8000-000000000001", "FriendlyName": "Contrat", "Name": "Contrat de prestation" }
    ],
    "TransactionMembers": [
      { "Id": "22222222-0000-4000-8000-000000000002", "FriendlyName": "Client", "MemberRole": 0, "SignMode": 1, "ExternalId": "CLIENT-881" }
    ],
    "TransactionFields": [
      { "TransactionMemberId": "22222222-0000-4000-8000-000000000002", "TransactionFileId": "11111111-0000-4000-8000-000000000001",
        "Pages": "-1", "Coordinates": "320,90,180,100" }
    ]
  }' \
  -F "Client=00000000-0000-4000-8000-000000000201" \
  -F "Contrat=@contrat-atelier-lumiere.pdf;type=application/pdf"

Vos identifiants ne sont pas gardés

Ils ne servent qu'à relier les fiches dans la requête : le serveur donne à chacune un identifiant neuf, et réécrit les liaisons. La réponse porte ces identifiants neufs ; retrouvez-y chaque fiche par son identifiant convivial (FriendlyName).

Pour garder votre propre référence sur une fiche — le numéro du dossier dans votre outil —, écrivez-la dans ExternalId (128 caractères au plus) : elle reste sur le parcours, le participant ou le document, et se filtre dans une liste.

Les pièges

  • Les emplacements de signature se déclarent à la racine, dans TransactionFields. Imbriqués dans un participant — sous TransactionFields ou sous l'ancien nom TransactionMemberSignatureLocations —, ils sont ignorés, sans erreur. La clé « participant,document » du formulaire en pose aussi.
  • Une intégration qui comptait retrouver ses propres identifiants sur les fiches créées doit relire ceux de la réponse, ou passer par ExternalId.
  • Désignez la personne par la clé de son identifiant convivial (Client), comme ici : elle est contrôlée.