Capacity
| API | Description |
|---|---|
| GET api/capacity/whatcaniborrow?applicationId={applicationId}&inputAmount={inputAmount} |
Returns an amount of what the customer can borrow depending on their monthly NET income. |
| GET api/capacity/whatincomedoineed?applicationId={applicationId}&inputAmount={inputAmount} |
Get a value of what income a customer needs when borrowing a specific amount. |
| GET api/capacity?applicationId={applicationId} |
Provides a breakdown of the customers affordability. |
PreQual
| API | Description |
|---|---|
| GET api/prequal/question?applicationId={applicationId} |
Gets all current prequal questions and answers for the requested application id. |
| POST api/prequal/question?applicationId={applicationId} |
Only a complete PreQual will be processed fully. |
| POST api/prequal/unlock?applicationId={applicationId} |
Unlock a completed Prequal so you can make amendments. |
Esign
| API | Description |
|---|---|
| GET api/Esign/EsignLink?applicationId={applicationId}&sendToBroker={sendToBroker}&offPremises={offPremises} |
Get a Esign Link which will allow you to embed the link in your own communications. |
| POST api/Esign/SuppliersDocumentation?applicationId={applicationId}&suppliersDeclarationEmail={suppliersDeclarationEmail} |
Send the Supplier's Declaration to the email address provided.. |
Applicant
| API | Description |
|---|---|
| PUT api/applicant/dateofbirth?applicationId={applicationId}&customerSequence={customerSequence}&dob={dob} |
No documentation available. |
| POST api/applicant/dateofbirth?applicationId={applicationId}&customerSequence={customerSequence}&dob={dob} |
No documentation available. |
ProviderApplication
| API | Description |
|---|---|
| POST api/ProviderApplication |
Posting an application submits the application to us and performs a soft credit search on the applicant(s). An applicationId will be returned which then in turn can be used for posting a or checking the application status. |
Vehicle
| API | Description |
|---|---|
| POST api/Vehicle?applicationId={applicationId} |
Add a vehicle or update the vehicle on the application. |
| PUT api/Vehicle?applicationId={applicationId} |
Add a vehicle or update the vehicle on the application. |
Application
| API | Description |
|---|---|
| POST api/Application |
Posting an application submits the application to us and performs a soft credit search on the applicant(s). An applicationId will be returned which then in turn can be used for posting a or checking the application status. |
ApplicationStatus
| API | Description |
|---|---|
| POST api/ApplicationStatus |
There are two different ways to use the status check. One is to specify an application number which will return the current status of the specified application. The other is to specify a date and time, and the returned data will contain the current status for every application where the status has changed once or more after the specified time. |
| GET api/ApplicationStatus |
Returns a list of active application statuses. |
ApplicationDiary
| API | Description |
|---|---|
| POST api/ApplicationDiary?applicationId={applicationId} |
Send us a note which will be appended to the application diary. |
| GET api/ApplicationDiary?applicationId={applicationId}&fromDate={fromDate} |
Returns a list of diary notes for the supplied application Id. |