Signer

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Signer",
  "type": "object",
  "description": "A signer recipient who must sign the envelope documents.",
  "properties": {
    "recipientId": {
      "type": "string",
      "description": "Unique identifier for the recipient. Assigned by the sender."
    },
    "recipientIdGuid": {
      "type": "string",
      "description": "The GUID for the recipient."
    },
    "name": {
      "type": "string",
      "description": "The full legal name of the signer."
    },
    "email": {
      "type": "string",
      "description": "The email address of the signer."
    },
    "routingOrder": {
      "type": "string",
      "description": "The routing order of the signer. Lower numbers are processed first. Recipients with the same routing order sign in parallel."
    },
    "roleName": {
      "type": "string",
      "description": "The role name associated with the signer, used with templates."
    },
    "clientUserId": {
      "type": "string",
      "description": "The client user ID for embedded signing. When set, the recipient is an embedded signer and must sign through your application using a generated signing URL."
    },
    "status": {
      "type": "string",
      "description": "The status of the signer."
    },
    "signedDateTime": {
      "type": "string",
      "description": "The date and time the signer signed."
    },
    "deliveredDateTime": {
      "type": "string",
      "description": "The date and time the envelope was delivered to the signer."
    },
    "declinedDateTime": {
      "type": "string",
      "description": "The date and time the signer declined."
    },
    "declinedReason": {
      "type": "string",
      "description": "The reason the signer declined."
    },
    "identityVerification": {
      "type": "object",
      "description": "Identity verification settings for this recipient."
    },
    "phoneAuthentication": {
      "type": "object",
      "description": "Phone authentication settings."
    },
    "accessCode": {
      "type": "string",
      "description": "An access code the recipient must enter to access the envelope."
    },
    "requireIdLookup": {
      "type": "string",
      "description": "Whether ID lookup authentication is required."
    },
    "note": {
      "type": "string",
      "description": "A private note to the signer from the sender."
    }
  }
}