Plexe
Underwriting

Calculation and approval endpoint reference

Endpoints used during offer calculation, application completion, applicant onboarding, contract signing, and supporting document submission.

Calculation endpoints

MethodRouteInputResponse
POST/api/Calculation/application-loc-calculation-sliderapplicationId query + SliderRequestSlider results
POST/api/Calculation/application-loc-calculationapplicationId query + CalculationRequestCalculationResponse
POST/api/Calculation/application-invoice-calculationapplicationId query + CalculationRequestCalculationResponse
 
{
  "amount": 5000,
  "percentOfIncome": 0.15,
  "terms": 12,
  "fixedRepaymentCalculation": false
}

Slider requests require a non-zero amount.

Calculation requests require amount and terms between 7 and 52.

Application approval endpoints

MethodRouteInputResponse
POST/api/ApplicationApproval/add-company-details/{applicationId}CompanyDataRequestbool
POST/api/ApplicationApproval/add-primary-applicant-details/{applicationId}PrimaryApplicantRequestApplicant id string
POST/api/ApplicationApproval/add-secondary-applicant-details/{applicationId}SecondaryApplicantRequestApplicant id string
GET/api/ApplicationApproval/get-all-applicants/{applicationId}No bodyApplicant list
GET/api/ApplicationApproval/get-contracts/{applicationId}No bodyContract document list
GET/api/ApplicationApproval/get-contract-details/{applicationId}No bodyContractDetails
POST/api/ApplicationApproval/sign-contract/{applicationId}/{applicantId}SignaturesRequestbool
 
{
  "businessName": "Northwind Pty Ltd",
  "entityType": "Pty Ltd",
  "zipCode": "2000",
  "businessTaxId": "12-3456789",
  "city": "Sydney"
}

Document and bank account endpoints

MethodRouteInputResponse
GET/api/ApplicationApproval/get-all-bank-accounts/{applicationId}No bodyBank account list
GET/api/ApplicationApproval/get-primary-bank-account/{applicationId}No bodyPrimary bank account
POST/api/ApplicationApproval/set-primary-bank-account/{applicationId}/{id}Route idbool
GET/api/ApplicationApproval/get-required-documents/{applicationId}No bodyRequired document list
POST/api/ApplicationApproval/submit-required-document/{applicationId}supportingDocumentId, byte[] fileData, fileType, fileNamebool
POST/api/ApplicationApproval/submit-document/{applicationId}byte[] fileData, fileType, fileNamebool