PUT api/LoanApplication/Sign

Sign the specified loan application with option to get the signed documents

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ReturnSignedDocuments		boolean	None.
DocumentsFormat	This property is not mandatory, by default the format is always 'PDF'.	DocumentFormatEnum	None.
LoanApplicationId		globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "ReturnSignedDocuments": true,
  "DocumentsFormat": 1,
  "LoanApplicationId": "726fe30f-76e9-4648-81f1-ee2ba77edad0"
}

text/html

Sample:

{"ReturnSignedDocuments":true,"DocumentsFormat":1,"LoanApplicationId":"726fe30f-76e9-4648-81f1-ee2ba77edad0"}

application/xml, text/xml

Sample:

<SignLoanApplicationViewModel 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">726fe30f-76e9-4648-81f1-ee2ba77edad0</LoanApplicationId>
  <DocumentsFormat>PDF</DocumentsFormat>
  <ReturnSignedDocuments>true</ReturnSignedDocuments>
</SignLoanApplicationViewModel>

Response Information

Resource Description

There is possibility for response format without returning documents. Possible error responses: 1. Already signed loan application - {"errors": {"invalidFieldName": ["Error message containing more details about the failure."], "invalidFieldName2": ["Error message containing more details about the failure."]}}

APIDocumentsViewModel

Name	Type	Additional information
Documents	Dictionary of string [key] and string [value]	None.
ReturnedDocumentsFormat	DocumentFormatEnum	None.
LoanApplicationId	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "Documents": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "ReturnedDocumentsFormat": 1,
  "LoanApplicationId": "bf56c380-9e78-4490-b09a-98fa97ec90df"
}

text/html

Sample:

{"Documents":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"ReturnedDocumentsFormat":1,"LoanApplicationId":"bf56c380-9e78-4490-b09a-98fa97ec90df"}

application/xml, text/xml

Sample:

<APIDocumentsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.Services.CommonModels">
  <LoanApplicationId xmlns="http://schemas.datacontract.org/2004/07/OmniPort.ViewModel">bf56c380-9e78-4490-b09a-98fa97ec90df</LoanApplicationId>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Documents>
  <ReturnedDocumentsFormat>PDF</ReturnedDocumentsFormat>
</APIDocumentsViewModel>