Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| envelopeId |
The envelope identifier. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
The envelope, if it exists.
Nano.Envelope| Name | Description | Type | Additional information |
|---|---|---|---|
| completed |
Gets or sets the completed. |
date |
None. |
| created |
Gets or sets the created. |
date |
None. |
| declined |
Gets or sets the declined. |
date |
None. |
| deleted |
Gets or sets the deleted. |
date |
None. |
| delivered |
Gets or sets the delivered. |
date |
None. |
| disclosureType |
Gets or sets the disclosure type. |
string |
None. |
| envelopeGuid |
Gets or sets the envelope unique identifier. |
globally unique identifier |
None. |
| lastModified |
Gets or sets the last modified. |
date |
None. |
| loanProcessEventCategory |
Gets or sets the loan process event category. |
string |
None. |
| loanProcessEventCode |
Gets or sets the loan process event code. |
string |
None. |
| paperDocumentsReceived |
Gets or sets the last PaperDocumentsReceived. |
date |
None. |
| remoteId |
Gets or sets the RemoteId -- an ID set by a signing service. |
string |
None. |
| sent |
Gets or sets the sent. |
date |
None. |
| signatureEnabled |
Gets or sets the signature enabled. |
boolean |
None. |
| signatureMedium |
Gets or sets the signature medium. |
string |
None. |
| status |
Gets or sets the status. |
string |
None. |
| statusChanged |
Gets or sets the status changed. |
date |
None. |
| updateCount |
Gets or sets the update count. |
integer |
None. |
| updated |
Gets or sets the updated. |
date |
None. |
| voided |
Gets or sets the voided. |
date |
None. |
| voidedReason |
Gets or sets the voided reason. |
string |
None. |
| app |
Gets or sets the application identifier. |
integer |
None. |
| id |
Gets or sets the envelope identifier. |
integer |
None. |
| requestedBy |
Gets or sets the user identifier. |
integer |
None. |
| envelopeDocuments |
Gets or sets the envelope documents. |
Collection of integer |
None. |
| envelopeRecipients |
Gets or sets the envelope recipients. |
Collection of integer |
None. |
Response Formats
application/json, text/json
{
"completed": "2025-04-25T18:34:07.8094737Z",
"created": "2025-04-25T18:34:07.8094737Z",
"declined": "2025-04-25T18:34:07.8094737Z",
"deleted": "2025-04-25T18:34:07.8094737Z",
"delivered": "2025-04-25T18:34:07.8094737Z",
"disclosureType": "sample String 1",
"envelopeGuid": "a6a5e6fd-7a67-4e7c-819e-eed2ea59aa4c",
"lastModified": "2025-04-25T18:34:07.8094737Z",
"loanProcessEventCategory": "sample String 3",
"loanProcessEventCode": "sample String 4",
"paperDocumentsReceived": "2025-04-25T18:34:07.8094737Z",
"remoteId": "sample String 5",
"sent": "2025-04-25T18:34:07.8094737Z",
"signatureEnabled": true,
"signatureMedium": "sample String 6",
"status": "sample String 7",
"statusChanged": "2025-04-25T18:34:07.8094737Z",
"updateCount": 8,
"updated": "2025-04-25T18:34:07.8094737Z",
"voided": "2025-04-25T18:34:07.8094737Z",
"voidedReason": "sample String 9",
"app": "10",
"id": "11",
"requestedBy": "1",
"envelopeDocuments": [
"1",
"2"
],
"envelopeRecipients": [
"1",
"2"
]
}
text/html
{"completed":"2025-04-25T18:34:07.8094737Z","created":"2025-04-25T18:34:07.8094737Z","declined":"2025-04-25T18:34:07.8094737Z","deleted":"2025-04-25T18:34:07.8094737Z","delivered":"2025-04-25T18:34:07.8094737Z","disclosureType":"sample String 1","envelopeGuid":"a6a5e6fd-7a67-4e7c-819e-eed2ea59aa4c","lastModified":"2025-04-25T18:34:07.8094737Z","loanProcessEventCategory":"sample String 3","loanProcessEventCode":"sample String 4","paperDocumentsReceived":"2025-04-25T18:34:07.8094737Z","remoteId":"sample String 5","sent":"2025-04-25T18:34:07.8094737Z","signatureEnabled":true,"signatureMedium":"sample String 6","status":"sample String 7","statusChanged":"2025-04-25T18:34:07.8094737Z","updateCount":8,"updated":"2025-04-25T18:34:07.8094737Z","voided":"2025-04-25T18:34:07.8094737Z","voidedReason":"sample String 9","app":"10","id":"11","requestedBy":"1","envelopeDocuments":["1","2"],"envelopeRecipients":["1","2"]}
application/vnd.api+json
Sample not available.