GET api/LoanApplication/Sign/Url/{loanApplicationId}/{shouldSendSigningLink}

Send email to the customer for signing documents

Request Information

URI Parameters

NameDescriptionTypeAdditional information
loanApplicationId

globally unique identifier

Required
shouldSendSigningLink

Set the value of this property to "true" if you want to send link for signing documents to the customer.

 boolean

Required

Body Parameters

None.

Response Information

Resource Description

Possible error responses: 1. Error occurred - {"ErrorMessage" : "Error message from Experian"}

NewSignUrlResponse
NameDescriptionTypeAdditional information
LoanApplicationId

globally unique identifier

None.
SignDocumentsUrl

string

None.
ExpirationDate

date

None.

Response Formats

application/json, text/json

Sample: 
{
  "LoanApplicationId": "d28ca919-ae92-4aee-83ca-4e17b2078693",
  "SignDocumentsUrl": "sample string 2",
  "ExpirationDate": "2025-12-16T03:03:39.0950635+00:00"
}

text/html

Sample: 
{"LoanApplicationId":"d28ca919-ae92-4aee-83ca-4e17b2078693","SignDocumentsUrl":"sample string 2","ExpirationDate":"2025-12-16T03:03:39.0950635+00:00"}

application/xml, text/xml

Sample: 
<NewSignUrlResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OmniPort.API.APIResponses">
  <ExpirationDate>2025-12-16T03:03:39.0950635+00:00</ExpirationDate>
  <LoanApplicationId>d28ca919-ae92-4aee-83ca-4e17b2078693</LoanApplicationId>
  <SignDocumentsUrl>sample string 2</SignDocumentsUrl>
</NewSignUrlResponse>