Document Recipient Status

Output representation of recipient status and sequence information for the signers.

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`contractDocumentVersionId`	String	Record ID of the contract document version.	Small, 61.0	61.0
`hasCurrentUserSigned`	Boolean	Indicates whether the current user has signed the document (`true`) or not (`false`). The default value is `false`.	Small, 61.0	61.0
`isCurrentUserRecipient`	Boolean	Indicates whether the current user is also a signer (`true`) or not (`false`). The default value is `false`.	Small, 61.0	61.0
`precedingSignersExists`	Boolean	Indicates whether the document is signed by preceding signers (`true`) or not (`false`). The default value is `false`.	Small, 61.0	61.0
`precedingSignersSigned`	Boolean	Indicates whether all preceding signers have completed their signatures (`true`) or not (`false`). The default value is `false`.	Small, 61.0	61.0
`recipientSequence`	Integer	Sequence number of the current user.	Small, 61.0	61.0
`recipients`	Recipients Response[]	List of all the signers involved in the contract document.	Big, 61.0	61.0

Sample Response

1{
2  "isCurrentUserRecipient": "true",
3  "hasCurrentUserSigned": "true",
4  "recipientSequence": "4",
5  "preceddingSignersExists": "true",
6  "preceedingSignersSigned": "true",
7  "Recipients": [
8    {
9      "Name": "Rishyv Misrep",
10      "email": "rishyv@salesforce.com",
11      "status": "Signed",
12      "finalStatusDateTime": ""
13    }
14  ]
15}