Docusign · Schema

Recipients

Contains the recipient collections for an envelope, organized by recipient type.

AgreementsContractsDigital Transaction ManagementDocumentsElectronic SignatureseSignature

Properties

Name	Type	Description
signers	array	List of signer recipients.
carbonCopies	array	List of carbon copy recipients who receive a copy of the completed envelope.
certifiedDeliveries	array	List of certified delivery recipients who must confirm receipt of the envelope.
inPersonSigners	array	List of in-person signer recipients for face-to-face signing scenarios.
agents	array	List of agent recipients who can designate another person to sign on their behalf.
editors	array	List of editor recipients who can modify the envelope before it is sent.
intermediaries	array	List of intermediary recipients who can forward the envelope to another person for signing.
witnesses	array	List of witness recipients who verify the identity of a signer.
recipientCount	string	The total number of recipients in the envelope.
currentRoutingOrder	string	The current routing order position.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Recipients",
  "type": "object",
  "description": "Contains the recipient collections for an envelope, organized by recipient type.",
  "properties": {
    "signers": {
      "type": "array",
      "description": "List of signer recipients."
    },
    "carbonCopies": {
      "type": "array",
      "description": "List of carbon copy recipients who receive a copy of the completed envelope."
    },
    "certifiedDeliveries": {
      "type": "array",
      "description": "List of certified delivery recipients who must confirm receipt of the envelope."
    },
    "inPersonSigners": {
      "type": "array",
      "description": "List of in-person signer recipients for face-to-face signing scenarios."
    },
    "agents": {
      "type": "array",
      "description": "List of agent recipients who can designate another person to sign on their behalf."
    },
    "editors": {
      "type": "array",
      "description": "List of editor recipients who can modify the envelope before it is sent."
    },
    "intermediaries": {
      "type": "array",
      "description": "List of intermediary recipients who can forward the envelope to another person for signing."
    },
    "witnesses": {
      "type": "array",
      "description": "List of witness recipients who verify the identity of a signer."
    },
    "recipientCount": {
      "type": "string",
      "description": "The total number of recipients in the envelope."
    },
    "currentRoutingOrder": {
      "type": "string",
      "description": "The current routing order position."
    }
  }
}