POST api/LoanApplication/Documents/Upload

Upload documents for a Loan Application in Customer Action Required status

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DocumentType	string	None.
Notes	string	None.
Files	Collection of File	None.
LoanApplicationId	globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentType": "sample string 1",
  "Notes": "sample string 2",
  "Files": [
    {
      "FileName": "sample string 1",
      "FileContent": "sample string 2"
    },
    {
      "FileName": "sample string 1",
      "FileContent": "sample string 2"
    }
  ],
  "LoanApplicationId": "3fe2c12a-66d1-4b44-8f72-2e1b86e94e6a"
}

text/html

Sample:

{"DocumentType":"sample string 1","Notes":"sample string 2","Files":[{"FileName":"sample string 1","FileContent":"sample string 2"},{"FileName":"sample string 1","FileContent":"sample string 2"}],"LoanApplicationId":"3fe2c12a-66d1-4b44-8f72-2e1b86e94e6a"}

application/xml, text/xml

Sample:

<UploadDocumentsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIRequests.LoanApplicationRequestModels">
  <LoanApplicationId xmlns="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel">3fe2c12a-66d1-4b44-8f72-2e1b86e94e6a</LoanApplicationId>
  <DocumentType>sample string 1</DocumentType>
  <Files>
    <File>
      <FileContent>sample string 2</FileContent>
      <FileName>sample string 1</FileName>
    </File>
    <File>
      <FileContent>sample string 2</FileContent>
      <FileName>sample string 1</FileName>
    </File>
  </Files>
  <Notes>sample string 2</Notes>
</UploadDocumentsModel>

Response Information

Resource Description

Possible error responses: {"errors": { "LoanApplicationId": ["The loan application field is invalid."], "LoanApplicationId": ["The application is not in Customer Action Required status."], "LoanApplicationId": ["You can't Upload information when no information has been requested."], "FileContent": ["The file content is not recognized as a valid Base64 format."], "DocumentType": ["The provided Document type does not exist or is not active."], "error": ["An error occurred while saving the note."]}}

UploadDocumentsResponse

Name	Description	Type	Additional information
LoanApplicationId		string	None.
LoanApplicationStatus		string	None.

Response Formats

application/json, text/json

Sample:

{
  "LoanApplicationId": "sample string 1",
  "LoanApplicationStatus": "sample string 2"
}

text/html

Sample:

{"LoanApplicationId":"sample string 1","LoanApplicationStatus":"sample string 2"}

application/xml, text/xml

Sample:

<UploadDocumentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.APIResponses.LoanApplicationResponses">
  <LoanApplicationId>sample string 1</LoanApplicationId>
  <LoanApplicationStatus>sample string 2</LoanApplicationStatus>
</UploadDocumentsResponse>