POST AddDocumentRequests
Request Information
URI Parameters
None.
Body Parameters
DocumentRequestAPIRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| documentRequests | Collection of DocumentRequest |
None. |
|
| PairIndex | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"documentRequests": [
{
"Id": 1,
"UserId": 2,
"UserEmail": "sample string 3",
"FullName": "sample string 4",
"ApplicationId": 1,
"LoanGuid": "ccbc57d7-d4df-496a-a89a-1b8ce7656018",
"DocumentRequestName": "sample string 5",
"RequestedDatetime": "2026-04-01T02:15:55.611873-04:00",
"LoanOfficerNotifiedDatetime": "2026-04-01T02:15:55.611873-04:00",
"Origination": "sample string 7",
"isAccepted": true,
"Notes": "sample string 8",
"GoodThrough": "2026-04-01T02:15:55.611873-04:00",
"UploadedDocuments": [
{
"Id": 1,
"DocumentRequestId": 2,
"UploadFileName": "sample string 3",
"AwsFileName": "sample string 4",
"CreatedOn": "2026-04-01T02:15:55.611873-04:00",
"EncompassAttachmentId": "0cfa45ea-4697-41bd-aeb0-531352bc4ae1"
},
{
"Id": 1,
"DocumentRequestId": 2,
"UploadFileName": "sample string 3",
"AwsFileName": "sample string 4",
"CreatedOn": "2026-04-01T02:15:55.611873-04:00",
"EncompassAttachmentId": "0cfa45ea-4697-41bd-aeb0-531352bc4ae1"
}
],
"HasAtLeastOneGoodUploadedDocument": true
},
{
"Id": 1,
"UserId": 2,
"UserEmail": "sample string 3",
"FullName": "sample string 4",
"ApplicationId": 1,
"LoanGuid": "ccbc57d7-d4df-496a-a89a-1b8ce7656018",
"DocumentRequestName": "sample string 5",
"RequestedDatetime": "2026-04-01T02:15:55.611873-04:00",
"LoanOfficerNotifiedDatetime": "2026-04-01T02:15:55.611873-04:00",
"Origination": "sample string 7",
"isAccepted": true,
"Notes": "sample string 8",
"GoodThrough": "2026-04-01T02:15:55.611873-04:00",
"UploadedDocuments": [
{
"Id": 1,
"DocumentRequestId": 2,
"UploadFileName": "sample string 3",
"AwsFileName": "sample string 4",
"CreatedOn": "2026-04-01T02:15:55.611873-04:00",
"EncompassAttachmentId": "0cfa45ea-4697-41bd-aeb0-531352bc4ae1"
},
{
"Id": 1,
"DocumentRequestId": 2,
"UploadFileName": "sample string 3",
"AwsFileName": "sample string 4",
"CreatedOn": "2026-04-01T02:15:55.611873-04:00",
"EncompassAttachmentId": "0cfa45ea-4697-41bd-aeb0-531352bc4ae1"
}
],
"HasAtLeastOneGoodUploadedDocument": true
}
],
"PairIndex": 1
}
application/xml, text/xml
Sample:
<DocumentRequestAPIRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LoanButler.Model.Model">
<PairIndex>1</PairIndex>
<documentRequests xmlns:d2p1="http://schemas.datacontract.org/2004/07/LoanButler.Model.Entity">
<d2p1:DocumentRequest>
<d2p1:ApplicationId>1</d2p1:ApplicationId>
<d2p1:DocumentRequestName>sample string 5</d2p1:DocumentRequestName>
<d2p1:FullName>sample string 4</d2p1:FullName>
<d2p1:GoodThrough>2026-04-01T02:15:55.611873-04:00</d2p1:GoodThrough>
<d2p1:Id>1</d2p1:Id>
<d2p1:LoanGuid>ccbc57d7-d4df-496a-a89a-1b8ce7656018</d2p1:LoanGuid>
<d2p1:LoanOfficerNotifiedDatetime>2026-04-01T02:15:55.611873-04:00</d2p1:LoanOfficerNotifiedDatetime>
<d2p1:Notes>sample string 8</d2p1:Notes>
<d2p1:Origination>sample string 7</d2p1:Origination>
<d2p1:RequestedDatetime>2026-04-01T02:15:55.611873-04:00</d2p1:RequestedDatetime>
<d2p1:UploadedDocuments>
<d2p1:UploadedDocument>
<d2p1:AwsFileName>sample string 4</d2p1:AwsFileName>
<d2p1:CreatedOn>2026-04-01T02:15:55.611873-04:00</d2p1:CreatedOn>
<d2p1:DocumentRequestId>2</d2p1:DocumentRequestId>
<d2p1:EncompassAttachmentId>0cfa45ea-4697-41bd-aeb0-531352bc4ae1</d2p1:EncompassAttachmentId>
<d2p1:Id>1</d2p1:Id>
<d2p1:UploadFileName>sample string 3</d2p1:UploadFileName>
</d2p1:UploadedDocument>
<d2p1:UploadedDocument>
<d2p1:AwsFileName>sample string 4</d2p1:AwsFileName>
<d2p1:CreatedOn>2026-04-01T02:15:55.611873-04:00</d2p1:CreatedOn>
<d2p1:DocumentRequestId>2</d2p1:DocumentRequestId>
<d2p1:EncompassAttachmentId>0cfa45ea-4697-41bd-aeb0-531352bc4ae1</d2p1:EncompassAttachmentId>
<d2p1:Id>1</d2p1:Id>
<d2p1:UploadFileName>sample string 3</d2p1:UploadFileName>
</d2p1:UploadedDocument>
</d2p1:UploadedDocuments>
<d2p1:UserEmail>sample string 3</d2p1:UserEmail>
<d2p1:UserId>2</d2p1:UserId>
<d2p1:isAccepted>true</d2p1:isAccepted>
</d2p1:DocumentRequest>
<d2p1:DocumentRequest>
<d2p1:ApplicationId>1</d2p1:ApplicationId>
<d2p1:DocumentRequestName>sample string 5</d2p1:DocumentRequestName>
<d2p1:FullName>sample string 4</d2p1:FullName>
<d2p1:GoodThrough>2026-04-01T02:15:55.611873-04:00</d2p1:GoodThrough>
<d2p1:Id>1</d2p1:Id>
<d2p1:LoanGuid>ccbc57d7-d4df-496a-a89a-1b8ce7656018</d2p1:LoanGuid>
<d2p1:LoanOfficerNotifiedDatetime>2026-04-01T02:15:55.611873-04:00</d2p1:LoanOfficerNotifiedDatetime>
<d2p1:Notes>sample string 8</d2p1:Notes>
<d2p1:Origination>sample string 7</d2p1:Origination>
<d2p1:RequestedDatetime>2026-04-01T02:15:55.611873-04:00</d2p1:RequestedDatetime>
<d2p1:UploadedDocuments>
<d2p1:UploadedDocument>
<d2p1:AwsFileName>sample string 4</d2p1:AwsFileName>
<d2p1:CreatedOn>2026-04-01T02:15:55.611873-04:00</d2p1:CreatedOn>
<d2p1:DocumentRequestId>2</d2p1:DocumentRequestId>
<d2p1:EncompassAttachmentId>0cfa45ea-4697-41bd-aeb0-531352bc4ae1</d2p1:EncompassAttachmentId>
<d2p1:Id>1</d2p1:Id>
<d2p1:UploadFileName>sample string 3</d2p1:UploadFileName>
</d2p1:UploadedDocument>
<d2p1:UploadedDocument>
<d2p1:AwsFileName>sample string 4</d2p1:AwsFileName>
<d2p1:CreatedOn>2026-04-01T02:15:55.611873-04:00</d2p1:CreatedOn>
<d2p1:DocumentRequestId>2</d2p1:DocumentRequestId>
<d2p1:EncompassAttachmentId>0cfa45ea-4697-41bd-aeb0-531352bc4ae1</d2p1:EncompassAttachmentId>
<d2p1:Id>1</d2p1:Id>
<d2p1:UploadFileName>sample string 3</d2p1:UploadFileName>
</d2p1:UploadedDocument>
</d2p1:UploadedDocuments>
<d2p1:UserEmail>sample string 3</d2p1:UserEmail>
<d2p1:UserId>2</d2p1:UserId>
<d2p1:isAccepted>true</d2p1:isAccepted>
</d2p1:DocumentRequest>
</documentRequests>
</DocumentRequestAPIRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |