Applications

Application endpoint reference

Endpoints for creating customers, creating applications, uploading banking data, reading status, and updating application details.

Create endpoints

MethodRouteInputResponse
POST/api/Application/create-customerUserRequestUserResponse
POST/api/Application/create-applicationApplicationRequestGuid
POST/api/Application/create-customer-and-applicationApplicationAndCustomerRequestApplicationCustomerResponse
POST/api/Application/create-customer-and-application-and-applicantCombined customer, application, applicant payloadApplicationCustomerResponse
POST/api/Application/create-application-and-applicantApplication plus applicant payloadGuid
{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "businessZip": "2000",
  "businessName": "Northwind Pty Ltd",
  "extraInformation": {
    "zipcode": "2000"
  }
}

create-customer requires first name, last name, email, mobile number, and a strong password.

create-application practically requires customerId and zip code through businessZip or extraInformation.zipcode.

Banking and processing

MethodRouteInputResponse
POST/api/Application/add-or-update-banking-data/{applicationId}bankName query param + BankingDataRequestbool
GET/api/Application/process-application/{applicationId}No bodyOffer Guid
POST/api/Application/submit-bankstatement-document/{applicationId}byte[] fileData, fileNamebool
{
  "bankAccounts": [
    {
      "bank": "Demo Bank",
      "availableBalance": "10000",
      "currentBalance": "10000",
      "accountNumber": "12345678",
      "routing": "062000",
      "accountType": "Business",
      "accountName": "Operating Account",
      "transactions": []
    }
  ]
}

Read and update endpoints

MethodRouteInputResponse
GET/api/Application/application-status/{applicationId}No bodystring
GET/api/Application/application-offer/{applicationId}No bodyOfferResponse
GET/api/Application/get-customer-applications/{customerId}No bodyApplication list
GET/api/Application/get-partner-applications/{partnerId}No bodyApplication list
GET/api/Application/get-application/{applicationId}No bodyApplication summary
GET/api/Application/update-application-name/{applicationId}name query parambool
GET/api/Application/update-application-name-and-zip-code/{applicationId}name, zipCode query paramsbool
GET/api/Application/update-customer-data/{applicationId}Multiple query paramsbool
GET/api/Application/update-application-data/{applicationId}name, zipcode, startDatebool
POST/api/Application/cancel-application/{applicationId}No bodybool