Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| envelopeId |
The envelope identifier. |
integer |
None. |
| appId |
The app identifier. |
integer |
None. |
| loanProcessEventCategories |
The loanProcessEventCategory. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
A list of envelope recipients.
Collection of Nano.EnvelopeRecipient| Name | Description | Type | Additional information |
|---|---|---|---|
| declined |
Gets or sets the declined. |
date |
None. |
| declinedReason |
Gets or sets the declined reason. |
string |
None. |
| delivered |
Gets or sets the delivered. |
date |
None. |
|
Gets or sets the email. |
string |
None. |
|
| name |
Gets or sets the name. |
string |
None. |
| recipientGuid |
Gets or sets the recipient unique identifier. |
globally unique identifier |
None. |
| recipientType |
Gets or sets the type of the recipient. |
string |
None. |
| roleName |
Gets or sets the role name. |
string |
None. |
| sent |
Gets or sets the sent. |
date |
None. |
| signed |
Gets or sets the signed. |
date |
None. |
| signerId |
Gets or sets the SignerId. |
string |
None. |
| status |
Gets or sets the status. |
string |
None. |
| envelope |
Gets or sets the envelope identifier. |
integer |
None. |
| id |
Gets or sets the envelope recipient identifier. |
integer |
None. |
| person |
Gets or sets the envelope identifier. |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"declined": "2025-04-25T18:19:54.1086051Z",
"declinedReason": "sample String 1",
"delivered": "2025-04-25T18:19:54.1086051Z",
"email": "sample String 2",
"name": "sample String 3",
"recipientGuid": "f0509e2a-7c51-40d1-9ca3-7a76f6280d08",
"recipientType": "sample String 5",
"roleName": "sample String 6",
"sent": "2025-04-25T18:19:54.1086051Z",
"signed": "2025-04-25T18:19:54.1086051Z",
"signerId": "sample String 7",
"status": "sample String 8",
"envelope": "9",
"id": "10",
"person": "1"
},
{
"declined": "2025-04-25T18:19:54.1086051Z",
"declinedReason": "sample String 1",
"delivered": "2025-04-25T18:19:54.1086051Z",
"email": "sample String 2",
"name": "sample String 3",
"recipientGuid": "f0509e2a-7c51-40d1-9ca3-7a76f6280d08",
"recipientType": "sample String 5",
"roleName": "sample String 6",
"sent": "2025-04-25T18:19:54.1086051Z",
"signed": "2025-04-25T18:19:54.1086051Z",
"signerId": "sample String 7",
"status": "sample String 8",
"envelope": "9",
"id": "10",
"person": "1"
}
]
text/html
Sample:
[{"declined":"2025-04-25T18:19:54.1086051Z","declinedReason":"sample String 1","delivered":"2025-04-25T18:19:54.1086051Z","email":"sample String 2","name":"sample String 3","recipientGuid":"f0509e2a-7c51-40d1-9ca3-7a76f6280d08","recipientType":"sample String 5","roleName":"sample String 6","sent":"2025-04-25T18:19:54.1086051Z","signed":"2025-04-25T18:19:54.1086051Z","signerId":"sample String 7","status":"sample String 8","envelope":"9","id":"10","person":"1"},{"declined":"2025-04-25T18:19:54.1086051Z","declinedReason":"sample String 1","delivered":"2025-04-25T18:19:54.1086051Z","email":"sample String 2","name":"sample String 3","recipientGuid":"f0509e2a-7c51-40d1-9ca3-7a76f6280d08","recipientType":"sample String 5","roleName":"sample String 6","sent":"2025-04-25T18:19:54.1086051Z","signed":"2025-04-25T18:19:54.1086051Z","signerId":"sample String 7","status":"sample String 8","envelope":"9","id":"10","person":"1"}]
application/xml, text/xml
Sample:
<ArrayOfEnvelopeRecipient xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<EnvelopeRecipient>
<Declined>2025-04-25T18:19:54.1086051Z</Declined>
<DeclinedReason>sample String 1</DeclinedReason>
<Delivered>2025-04-25T18:19:54.1086051Z</Delivered>
<Email>sample String 2</Email>
<Name>sample String 3</Name>
<RecipientGuid>f0509e2a-7c51-40d1-9ca3-7a76f6280d08</RecipientGuid>
<RecipientType>sample String 5</RecipientType>
<RoleName>sample String 6</RoleName>
<Sent>2025-04-25T18:19:54.1086051Z</Sent>
<Signed>2025-04-25T18:19:54.1086051Z</Signed>
<SignerId>sample String 7</SignerId>
<Status>sample String 8</Status>
<EnvelopeId>9</EnvelopeId>
<EnvelopeRecipientId>10</EnvelopeRecipientId>
<PersonId>1</PersonId>
</EnvelopeRecipient>
<EnvelopeRecipient>
<Declined>2025-04-25T18:19:54.1086051Z</Declined>
<DeclinedReason>sample String 1</DeclinedReason>
<Delivered>2025-04-25T18:19:54.1086051Z</Delivered>
<Email>sample String 2</Email>
<Name>sample String 3</Name>
<RecipientGuid>f0509e2a-7c51-40d1-9ca3-7a76f6280d08</RecipientGuid>
<RecipientType>sample String 5</RecipientType>
<RoleName>sample String 6</RoleName>
<Sent>2025-04-25T18:19:54.1086051Z</Sent>
<Signed>2025-04-25T18:19:54.1086051Z</Signed>
<SignerId>sample String 7</SignerId>
<Status>sample String 8</Status>
<EnvelopeId>9</EnvelopeId>
<EnvelopeRecipientId>10</EnvelopeRecipientId>
<PersonId>1</PersonId>
</EnvelopeRecipient>
</ArrayOfEnvelopeRecipient>
application/vnd.api+json
Sample:
Sample not available.