Référence de l'API

Destinataires

Les personnes d'un document : les signataires, et celles qui reçoivent une copie (cc).

Points de terminaison · 7

POST Ajouter un destinataire
GET Lister les destinataires
GET Récupérer un destinataire
PATCH Mettre à jour un destinataire
DELETE Retirer un destinataire
POST Envoyer un rappel maintenant
POST Créer une session de signature intégrée

L'objet

Champ	Saisir	Description
`id`	string	Identifiant unique, commençant par rcp_.
`object`	string	Toujours "recipient".
`name, email`	string	Qui c'est.
`role`	enum	signer ou cc.
`signing_order`	integer	En signature séquentielle, les plus petits numéros signent d'abord. Les personnes avec le même numéro signent en même temps.
`locale`	enum	en ou fr : la langue de ses courriels et de sa page de signature.
`template_role`	string ou null	Le rôle du modèle qu'il remplit.
`access_code`	boolean	true s'il a besoin d'un code d'accès de votre part pour ouvrir le document.
`status`	enum	pending, sent, viewed, signed ou declined.
`sent_at, viewed_at, signed_at, declined_at`	timestamp ou null	Ce qu'il a fait, et quand.
`decline_reason`	string ou null	Sa raison, s'il a refusé.

POST/documents/{id}/recipients

Ajouter un destinataire

Brouillons seulement.

Paramètre	Saisir		Description
`name`	string	obligatoire	Jusqu'à 120 caractères.
`email`	string	obligatoire	Chaque adresse une seule fois par document.
`role`	enum	facultatif	signer (par défaut) ou cc.
`signing_order`	integer	facultatif	De 1 à 50. Par défaut : après les autres.
`locale`	enum	facultatif	en ou fr.
`access_code`	string	facultatif	Un code que vous lui donnez vous-même, de 4 à 40 caractères. Seule son empreinte est conservée.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/recipients" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Maya Chen", "email": "maya.chen@example.com", "locale": "en" }'

Réponse

json

{
  "id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
  "object": "recipient",
  "name": "Maya Chen",
  "email": "maya.chen@example.com",
  "role": "signer",
  "signing_order": 1,
  "locale": "en",
  "template_role": null,
  "access_code": false,
  "status": "sent",
  "sent_at": "2026-11-02T14:05:11.000Z",
  "viewed_at": null,
  "signed_at": null,
  "declined_at": null,
  "decline_reason": null
}

GET/documents/{id}/recipients

Lister les destinataires

Dans l'ordre de signature.

Requête

bash

curl "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/recipients" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "object": "list",
  "data": [
    {
      "id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
      "object": "recipient",
      "name": "Maya Chen",
      "email": "maya.chen@example.com",
      "role": "signer",
      "signing_order": 1,
      "locale": "en",
      "template_role": null,
      "access_code": false,
      "status": "sent",
      "sent_at": "2026-11-02T14:05:11.000Z",
      "viewed_at": null,
      "signed_at": null,
      "declined_at": null,
      "decline_reason": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET/documents/{id}/recipients/{recipient_id}

Récupérer un destinataire

Requête

bash

curl "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/recipients/rcp_5ZR3qa7yEeeby3abP3E2Zs" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
  "object": "recipient",
  "name": "Maya Chen",
  "email": "maya.chen@example.com",
  "role": "signer",
  "signing_order": 1,
  "locale": "en",
  "template_role": null,
  "access_code": false,
  "status": "sent",
  "sent_at": "2026-11-02T14:05:11.000Z",
  "viewed_at": null,
  "signed_at": null,
  "declined_at": null,
  "decline_reason": null
}

PATCH/documents/{id}/recipients/{recipient_id}

Mettre à jour un destinataire

Brouillons seulement. Pour corriger un nom ou un courriel après l'envoi, utilisez Corriger dans l'application.

Paramètre	Saisir		Description
`name, email, role, signing_order, locale, access_code`		facultatif	Comme dans Ajouter un destinataire.

Requête

bash

curl -X PATCH "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/recipients/rcp_5ZR3qa7yEeeby3abP3E2Zs" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "email": "m.chen@example.com" }'

Réponse

json

{
  "id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
  "object": "recipient",
  "name": "Maya Chen",
  "email": "maya.chen@example.com",
  "role": "signer",
  "signing_order": 1,
  "locale": "en",
  "template_role": null,
  "access_code": false,
  "status": "sent",
  "sent_at": "2026-11-02T14:05:11.000Z",
  "viewed_at": null,
  "signed_at": null,
  "declined_at": null,
  "decline_reason": null
}

DELETE/documents/{id}/recipients/{recipient_id}

Retirer un destinataire

Brouillons seulement. Ses champs sont aussi retirés.

Requête

bash

curl -X DELETE "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/recipients/rcp_5ZR3qa7yEeeby3abP3E2Zs" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{ "id": "rcp_5ZR3qa7yEeeby3abP3E2Zs", "object": "recipient", "deleted": true }

POST/documents/{id}/recipients/{recipient_id}/remind

Envoyer un rappel maintenant

Envoie un rappel par courriel à un signataire dont c'est le tour et qui n'a pas signé. Au plus un courriel par personne par heure.

Paramètre	Saisir		Description
`Idempotency-Key`	en-tête	obligatoire	Une valeur unique pour cette action, de 8 à 200 caractères. Voyez Idempotence.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/recipients/rcp_5ZR3qa7yEeeby3abP3E2Zs/remind" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'

Réponse

json

{ "id": "rcp_5ZR3qa7yEeeby3abP3E2Zs", "object": "recipient", "reminded": true }

POST/documents/{id}/recipients/{recipient_id}/signing-sessions

Créer une session de signature intégrée

Une URL à usage unique pour afficher la page de signature dans votre site, pour un signataire que vous avez identifié vous-même. Le document doit être envoyé. Voyez Signature intégrée.

Paramètre	Saisir		Description
`return_url`	string	facultatif	HTTPS (ou http://localhost pendant le développement). Là où va le signataire après avoir signé, avec ?event=signing_complete ajouté.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/documents/doc_3y9Pf34qY6Nb3wWD25RQ4F/recipients/rcp_5ZR3qa7yEeeby3abP3E2Zs/signing-sessions" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "return_url": "https://portal.example.com/signed" }'

Réponse

json

{
  "object": "signing_session",
  "recipient_id": "rcp_5ZR3qa7yEeeby3abP3E2Zs",
  "url": "https://sign.esorasign.com/embed/7Hk2…",
  "expires_at": "2026-11-02T14:12:00.000Z",
  "note": "Open within 5 minutes. The URL works once. Add your site to the workspace embed_origins to show it in a frame."
}