Customer and application objects
UserRequest and UserResponse are used for customer creation.
ApplicationRequest is used when creating an application for an existing customer.
ApplicationAndCustomerRequest is used for combined customer-and-application creation flows.
ApplicationCustomerResponse returns the created application and customer identifiers. Separate application creation returns a GUID string.
UserResponse describes customer details and an ID; it does not document a returned password.
Calculation and underwriting objects
SliderRequest, CalculationRequest, and CalculationResponse are used by calculation routes.
CompanyDataRequest, PrimaryApplicantRequest, and SecondaryApplicantRequest are used during application approval.
SignaturesRequest is used when signing contracts.
ContractDetails is returned by the contract details route. The approval guide explains a known discrepancy between its Swagger array schema and the returned object.
Loan, communication, and webhook objects
LoanResponse, LoanBalanceResponse, and DashboardLoanRepaymentResponse are common loan read responses.
LineOfCreditWithdrawalRequest, InvoiceWithdrawalRequest, and their response types are used for withdrawal flows.
CommunicationRequest is used for application messaging.
WebhookSubscription is the input object for webhook registration and update flows.
GuidApiResponse is the invoice-confirmation envelope. Most endpoints return their declared value directly.
A string with format byte is base64; format uuid is a GUID. Dictionary value types appear under additionalProperties. Check validation rules alongside the schema.
Advance
{
"type": "object",
"properties": {
"loanId": {
"type": "string",
"format": "uuid"
},
"customerEmail": {
"type": "string",
"x-nullable": true
},
"businessName": {
"type": "string",
"x-nullable": true
},
"fullBusinessName": {
"type": "string",
"x-nullable": true
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"amount": {
"type": "number",
"format": "double",
"x-nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"advanceRate": {
"type": "number",
"format": "double"
},
"term": {
"type": "integer",
"format": "int32"
},
"isFixedRepayment": {
"type": "boolean",
"x-nullable": true
},
"isPercentageofIncome": {
"type": "boolean",
"x-nullable": true
},
"percentOfIncome": {
"type": "number",
"format": "double"
},
"advanceId": {
"type": "string",
"format": "uuid"
},
"customerName": {
"type": "string",
"x-nullable": true
},
"customerId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
AdvanceProjectionResponse
{
"type": "object",
"properties": {
"terms": {
"type": "integer",
"format": "int32",
"x-nullable": true
},
"priority": {
"type": "boolean",
"x-nullable": true
},
"percentage": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeks": {
"type": "integer",
"format": "int32",
"x-nullable": true
},
"name": {
"type": "string",
"x-nullable": true
},
"earlyRepaid": {
"type": "boolean",
"x-nullable": true
},
"earlyRepaidDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"overrideLastRepaymentDateUTC": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"overrideLastRepayment": {
"type": "boolean",
"x-nullable": true
},
"legacy": {
"type": "boolean",
"x-nullable": true
},
"monthlyFee": {
"type": "boolean",
"x-nullable": true
},
"commission": {
"$ref": "#/definitions/ApplicationCommission"
},
"fixedProperty": {
"type": "boolean",
"x-nullable": true
},
"advanceRate": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeklyPayment": {
"type": "number",
"format": "double",
"x-nullable": true
},
"totalRepaymentAmount": {
"type": "number",
"format": "double",
"x-nullable": true
},
"lastRepaymentDateUTC": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"lastRepaymentDay": {
"type": "string",
"x-nullable": true
},
"nextRepaymentDay": {
"type": "string",
"x-nullable": true
},
"actualNextRepaymentDay": {
"type": "string",
"x-nullable": true
},
"actualNextRepaymentDateUTC": {
"type": "string",
"format": "date-time",
"readOnly": true,
"x-nullable": true
},
"nextRepaymentDateUTC": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"nextRepaymentValue": {
"$ref": "#/definitions/AmountResponse"
},
"remaining": {
"$ref": "#/definitions/AmountResponse"
},
"amount": {
"$ref": "#/definitions/AmountResponse"
},
"details": {
"type": "string",
"x-nullable": true
},
"type": {
"type": "string",
"x-nullable": true
},
"dateUTC": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"loanId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"id": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"fixedRepayment": {
"type": "number",
"format": "double",
"x-nullable": true
},
"fixedRepaymentFee": {
"type": "number",
"format": "double",
"x-nullable": true
}
},
"additionalProperties": false
}
Agent
{
"type": "object",
"properties": {
"agentId": {
"type": "string",
"format": "uuid"
},
"businessName": {
"type": "string",
"x-nullable": true
},
"ccEmail": {
"type": "string",
"x-nullable": true
},
"city": {
"type": "string",
"x-nullable": true
},
"compliance": {
"type": "boolean"
},
"countryCode": {
"type": "string",
"x-nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time"
},
"deleted": {
"type": "boolean"
},
"deletedDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"email": {
"type": "string",
"x-nullable": true
},
"enabled": {
"type": "boolean"
},
"firstName": {
"type": "string",
"x-nullable": true
},
"formattedAddress": {
"type": "string",
"x-nullable": true
},
"isMaster": {
"type": "boolean",
"x-nullable": true
},
"lastName": {
"type": "string",
"x-nullable": true
},
"latitude": {
"type": "number",
"format": "double",
"x-nullable": true
},
"lockoutEnabled": {
"type": "boolean"
},
"longitude": {
"type": "number",
"format": "double",
"x-nullable": true
},
"mobile": {
"type": "string",
"x-nullable": true
},
"name": {
"type": "string",
"x-nullable": true
},
"notes": {
"type": "array",
"items": {
"$ref": "#/definitions/AgentNotes"
},
"x-nullable": true
},
"partnerBusinessName": {
"type": "string",
"x-nullable": true
},
"partnerId": {
"type": "string",
"format": "uuid"
},
"partnerName": {
"type": "string",
"x-nullable": true
},
"postalCode": {
"type": "string",
"x-nullable": true
},
"showTodo": {
"type": "boolean",
"x-nullable": true
},
"state": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
AgentNotes
{
"type": "object",
"properties": {
"agentId": {
"type": "string",
"format": "uuid"
},
"author": {
"type": "string",
"x-nullable": true
},
"note": {
"type": "string",
"x-nullable": true
},
"noteCreated": {
"type": "string",
"format": "date-time"
},
"noteId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
AmountResponse
{
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "double",
"x-nullable": true
},
"currencyCode": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
Application
{
"type": "object",
"properties": {
"secondaryApplicantRequested": {
"type": "boolean",
"x-nullable": true
},
"primaryApplicantAdded": {
"type": "boolean",
"x-nullable": true
},
"secondaryApplicantAdded": {
"type": "boolean",
"x-nullable": true
},
"loanType": {
"type": "string",
"x-nullable": true
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"customerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"businessName": {
"type": "string",
"x-nullable": true
},
"customerEmail": {
"type": "string",
"x-nullable": true
},
"shortCode": {
"type": "string",
"x-nullable": true
},
"statusName": {
"type": "string",
"x-nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"lastUpdatedDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"organisationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"offerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"agentId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"secured": {
"type": "boolean",
"x-nullable": true
},
"tradingName": {
"type": "string",
"x-nullable": true
},
"fullBusinessName": {
"type": "string",
"x-nullable": true
},
"offerAccepted": {
"type": "boolean",
"x-nullable": true
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
ApplicationAndApplicantRequest
{
"type": "object",
"properties": {
"applicant": {
"$ref": "#/definitions/ApplicationApplicant"
},
"customerId": {
"type": "string",
"format": "uuid"
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"agentId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"businessZip": {
"type": "string",
"x-nullable": true
},
"businessName": {
"type": "string",
"x-nullable": true
},
"extraInformation": {
"type": "object",
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-nullable": true
}
},
"additionalProperties": false
}
ApplicationAndCustomerAndApplicantRequest
{
"type": "object",
"properties": {
"applicant": {
"$ref": "#/definitions/ApplicationApplicant"
},
"secondaryApplicant": {
"$ref": "#/definitions/ApplicationApplicant"
},
"application": {
"$ref": "#/definitions/CustomerApplicationRequest"
},
"customer": {
"$ref": "#/definitions/UserRequest"
}
},
"additionalProperties": false
}
ApplicationAndCustomerRequest
{
"type": "object",
"properties": {
"application": {
"$ref": "#/definitions/CustomerApplicationRequest"
},
"customer": {
"$ref": "#/definitions/UserRequest"
}
},
"additionalProperties": false
}
ApplicationApplicant
{
"type": "object",
"properties": {
"firstName": {
"type": "string",
"x-nullable": true
},
"lastName": {
"type": "string",
"x-nullable": true
},
"city": {
"type": "string",
"x-nullable": true
},
"state": {
"type": "string",
"x-nullable": true
},
"address": {
"type": "string",
"x-nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"x-nullable": true
}
},
"additionalProperties": false
}
ApplicationCommission
{
"type": "object",
"properties": {
"upfrontFee": {
"type": "number",
"format": "double",
"x-nullable": true
},
"trailing": {
"type": "number",
"format": "double",
"x-nullable": true
},
"drawFee": {
"type": "number",
"format": "double",
"x-nullable": true
}
},
"additionalProperties": false
}
ApplicationCustomerResponse
{
"type": "object",
"properties": {
"customerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"applicationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"applicantId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"secondaryApplicantId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"organisationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
}
},
"additionalProperties": false
}
ApplicationRequest
{
"type": "object",
"properties": {
"customerId": {
"type": "string",
"format": "uuid"
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"agentId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"businessZip": {
"type": "string",
"x-nullable": true
},
"businessName": {
"type": "string",
"x-nullable": true
},
"extraInformation": {
"type": "object",
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-nullable": true
}
},
"additionalProperties": false
}
ApplicationResponse
{
"type": "object",
"properties": {
"applicationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"customerId": {
"type": "string",
"format": "uuid"
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"agentId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"businessZip": {
"type": "string",
"x-nullable": true
},
"businessName": {
"type": "string",
"x-nullable": true
},
"extraInformation": {
"type": "object",
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-nullable": true
}
},
"additionalProperties": false
}
BankAccount
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"accountNumber": {
"type": "string",
"x-nullable": true
},
"routingNumber": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
BankAccountRequest
{
"type": "object",
"required": [
"accountName",
"accountNumber",
"availableBalance",
"bank",
"routing"
],
"properties": {
"bank": {
"type": "string",
"minLength": 1
},
"availableBalance": {
"type": "string",
"minLength": 1
},
"currentBalance": {
"type": "string",
"x-nullable": true
},
"accountNumber": {
"type": "string",
"minLength": 1
},
"routing": {
"type": "string",
"minLength": 1
},
"accountType": {
"type": "string",
"x-nullable": true
},
"transactions": {
"type": "array",
"items": {
"$ref": "#/definitions/TransactionRequest"
},
"x-nullable": true
},
"accountName": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
BankDetails
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"accountNumber": {
"type": "string",
"x-nullable": true
},
"routingNumber": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
BankingDataRequest
{
"type": "object",
"properties": {
"bankAccounts": {
"type": "array",
"items": {
"$ref": "#/definitions/BankAccountRequest"
},
"x-nullable": true
}
},
"additionalProperties": false
}
CalculationRequest
{
"type": "object",
"required": [
"amount",
"percentOfIncome",
"terms"
],
"properties": {
"amount": {
"type": "number",
"format": "double"
},
"percentOfIncome": {
"type": "number",
"format": "double"
},
"terms": {
"type": "integer",
"format": "int32"
},
"fixedRepaymentCalculation": {
"type": "boolean"
}
},
"additionalProperties": false
}
CalculationResponse
{
"type": "object",
"required": [
"amount",
"percentOfIncome",
"terms"
],
"properties": {
"advanceRate": {
"type": "number",
"format": "double"
},
"totalRepayment": {
"type": "number",
"format": "double"
},
"repayment": {
"type": "number",
"format": "double"
},
"advanceFee": {
"type": "number",
"format": "double"
},
"weeks": {
"type": "integer",
"format": "int32"
},
"amount": {
"type": "number",
"format": "double"
},
"percentOfIncome": {
"type": "number",
"format": "double"
},
"terms": {
"type": "integer",
"format": "int32"
},
"fixedRepaymentCalculation": {
"type": "boolean"
}
},
"additionalProperties": false
}
CommunicationRequest
{
"type": "object",
"properties": {
"contents": {
"type": "string",
"x-nullable": true
},
"user": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
CompanyDataRequest
{
"type": "object",
"properties": {
"businessName": {
"type": "string",
"x-nullable": true
},
"entityType": {
"type": "string",
"x-nullable": true
},
"zipCode": {
"type": "string",
"x-nullable": true
},
"businessTaxId": {
"type": "string",
"x-nullable": true
},
"city": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
ContractDetails
{
"type": "object",
"properties": {
"companyName": {
"type": "string",
"x-nullable": true
},
"guarantors": {
"type": "string",
"x-nullable": true
},
"facilityLimit": {
"type": "number",
"format": "double"
},
"establishmentFee": {
"type": "string",
"x-nullable": true
},
"drawFee": {
"type": "string",
"x-nullable": true
},
"bankAccounts": {
"type": "array",
"items": {
"$ref": "#/definitions/BankAccount"
},
"x-nullable": true
},
"platformAgreementHTML": {
"type": "string",
"x-nullable": true
},
"platformAgreementSignCondition1": {
"type": "string",
"x-nullable": true
},
"platformAgreementSignCondition2": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
ContractDocumentResponse
{
"type": "object",
"properties": {
"displayName": {
"type": "string",
"x-nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"documentId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"data": {
"type": "string",
"format": "byte",
"x-nullable": true
},
"status": {
"$ref": "#/definitions/ContractDocumentStatusTypeResponse"
}
},
"additionalProperties": false
}
ContractDocumentStatusTypeResponse
{
"type": "integer",
"format": "int32",
"enum": [
0,
1,
2,
3
]
}
CustomerApplicationRequest
{
"type": "object",
"properties": {
"businessName": {
"type": "string",
"x-nullable": true
},
"businessZip": {
"type": "string",
"x-nullable": true
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"agentId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"extraInformation": {
"type": "object",
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-nullable": true
},
"notes": {
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true
}
},
"additionalProperties": false
}
DashboardLoanRepaymentResponse
{
"type": "object",
"properties": {
"loanRepayments": {
"type": "array",
"items": {
"$ref": "#/definitions/LoanRepaymentResponse"
},
"x-nullable": true
}
},
"additionalProperties": false
}
DebtorDetailsResponse
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"invoiceTypes": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "double",
"x-nullable": true
},
"x-nullable": true
}
},
"additionalProperties": false
}
DrivingLicenseRequest
{
"type": "object",
"properties": {
"issuingState": {
"type": "string",
"x-nullable": true
},
"cardNumber": {
"type": "string",
"x-nullable": true
},
"expiryDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"name": {
"type": "string",
"x-nullable": true
},
"address": {
"type": "string",
"x-nullable": true
},
"dateOfBirth": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"city": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
EarlyRepaymentResponse
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double",
"x-nullable": true
},
"principal": {
"type": "number",
"format": "double",
"x-nullable": true
},
"fee": {
"type": "number",
"format": "double",
"x-nullable": true
},
"notes": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
FileDetails
{
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"fileDateStr": {
"type": "string",
"x-nullable": true
},
"fileName": {
"type": "string",
"x-nullable": true
},
"fileType": {
"type": "string",
"x-nullable": true
},
"internalLocation": {
"type": "string",
"x-nullable": true
},
"isSecondary": {
"type": "boolean"
},
"location": {
"type": "string",
"x-nullable": true
},
"missingTransaction": {
"type": "boolean"
}
},
"additionalProperties": false
}
FullApplicationUser
{
"type": "object",
"properties": {
"avatarVersion": {
"type": "string",
"x-nullable": true
},
"departments": {
"type": "array",
"items": {
"$ref": "#/definitions/UserDepartment"
},
"x-nullable": true
},
"email": {
"type": "string",
"x-nullable": true
},
"expiresUTC": {
"type": "string",
"format": "date-time"
},
"firstName": {
"type": "string",
"x-nullable": true
},
"firstTime": {
"type": "boolean"
},
"hasAvatar": {
"type": "boolean"
},
"id": {
"type": "string",
"x-nullable": true
},
"impersonationSessionId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"impersonatorEmail": {
"type": "string",
"x-nullable": true
},
"impersonatorId": {
"type": "string",
"x-nullable": true
},
"impersonatorName": {
"type": "string",
"x-nullable": true
},
"isImpersonating": {
"type": "boolean"
},
"lastName": {
"type": "string",
"x-nullable": true
},
"phoneRegion": {
"type": "string",
"x-nullable": true
},
"requiresTwoFactor": {
"type": "boolean"
},
"timeZoneId": {
"type": "string",
"x-nullable": true
},
"token": {
"type": "string",
"x-nullable": true
},
"trustedDeviceToken": {
"type": "string",
"x-nullable": true
},
"userType": {
"type": "string",
"x-nullable": true
},
"username": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
GuidApiResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"$ref": "#/definitions/ValidationError"
},
"x-nullable": true
},
"data": {
"type": "string",
"format": "uuid"
},
"success": {
"type": "boolean"
},
"message": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
Industry
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
InvoiceCustomer
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/LoanDebtorProjectionResponse"
},
"x-nullable": true
},
"totalCount": {
"type": "integer",
"format": "int64",
"x-nullable": true
}
},
"additionalProperties": false
}
InvoiceWithdrawalRequest
{
"type": "object",
"properties": {
"calculation": {
"$ref": "#/definitions/CalculationRequest"
}
},
"additionalProperties": false
}
InvoiceWithdrawalResponse
{
"type": "object",
"properties": {
"primaryBank": {
"$ref": "#/definitions/BankDetails"
},
"contactNumber": {
"type": "string",
"x-nullable": true
},
"advanceRate": {
"type": "number",
"format": "double",
"x-nullable": true
},
"applicationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"firstRepayment": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"isfixed": {
"type": "boolean",
"x-nullable": true
},
"id": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"isFirstAdavnce": {
"type": "boolean",
"x-nullable": true
},
"loanId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"percentageOfIncome": {
"type": "number",
"format": "double",
"x-nullable": true
},
"totalRepayment": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeklyForecastIncome": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeklyRepayment": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeks": {
"type": "integer",
"format": "int32",
"x-nullable": true
},
"withdrawAmount": {
"type": "number",
"format": "double",
"x-nullable": true
},
"otp": {
"type": "string",
"x-nullable": true
},
"calculation": {
"$ref": "#/definitions/CalculationRequest"
}
},
"additionalProperties": false
}
LineOfCreditWithdrawalRequest
{
"type": "object",
"properties": {
"calculation": {
"$ref": "#/definitions/CalculationRequest"
}
},
"additionalProperties": false
}
LineOfCreditWithdrawalResponse
{
"type": "object",
"properties": {
"primaryBank": {
"$ref": "#/definitions/BankDetails"
},
"contactNumber": {
"type": "string",
"x-nullable": true
},
"advanceRate": {
"type": "number",
"format": "double",
"x-nullable": true
},
"applicationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"firstRepayment": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"isfixed": {
"type": "boolean",
"x-nullable": true
},
"id": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"isFirstAdavnce": {
"type": "boolean",
"x-nullable": true
},
"loanId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"percentageOfIncome": {
"type": "number",
"format": "double",
"x-nullable": true
},
"totalRepayment": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeklyForecastIncome": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeklyRepayment": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeks": {
"type": "integer",
"format": "int32",
"x-nullable": true
},
"withdrawAmount": {
"type": "number",
"format": "double",
"x-nullable": true
},
"otp": {
"type": "string",
"x-nullable": true
},
"calculation": {
"$ref": "#/definitions/CalculationRequest"
}
},
"additionalProperties": false
}
Loan
{
"type": "object",
"properties": {
"loanId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"secondaryApplicantRequested": {
"type": "boolean",
"x-nullable": true
},
"primaryApplicantAdded": {
"type": "boolean",
"x-nullable": true
},
"secondaryApplicantAdded": {
"type": "boolean",
"x-nullable": true
},
"loanType": {
"type": "string",
"x-nullable": true
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"customerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"businessName": {
"type": "string",
"x-nullable": true
},
"customerEmail": {
"type": "string",
"x-nullable": true
},
"shortCode": {
"type": "string",
"x-nullable": true
},
"statusName": {
"type": "string",
"x-nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"lastUpdatedDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"organisationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"offerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"agentId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"secured": {
"type": "boolean",
"x-nullable": true
},
"tradingName": {
"type": "string",
"x-nullable": true
},
"fullBusinessName": {
"type": "string",
"x-nullable": true
},
"offerAccepted": {
"type": "boolean",
"x-nullable": true
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
LoanBalanceResponse
{
"type": "object",
"properties": {
"availableFunds": {
"type": "number",
"format": "double",
"readOnly": true,
"x-nullable": true
},
"systemPricing": {
"type": "number",
"format": "double",
"x-nullable": true
},
"balance": {
"type": "number",
"format": "double",
"x-nullable": true
},
"totalLimit": {
"type": "number",
"format": "double",
"readOnly": true,
"x-nullable": true
},
"limits": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "double",
"x-nullable": true
},
"x-nullable": true
},
"rawTotal": {
"type": "number",
"format": "double",
"x-nullable": true
},
"adjustment": {
"type": "number",
"format": "double",
"x-nullable": true
},
"totalDebtors": {
"type": "number",
"format": "double",
"x-nullable": true
},
"totalFundingRate": {
"type": "number",
"format": "double",
"x-nullable": true
}
},
"additionalProperties": false
}
LoanDebtorProjectionResponse
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"id": {
"type": "string",
"x-nullable": true
},
"details": {
"$ref": "#/definitions/DebtorDetailsResponse"
},
"approved": {
"type": "number",
"format": "double",
"x-nullable": true
},
"fundingRate": {
"type": "number",
"format": "double",
"x-nullable": true
},
"available": {
"type": "number",
"format": "double",
"x-nullable": true
},
"selected": {
"type": "boolean",
"x-nullable": true
},
"requested": {
"type": "boolean",
"x-nullable": true
},
"total": {
"type": "number",
"format": "double",
"x-nullable": true
},
"adminSelected": {
"type": "boolean",
"x-nullable": true
}
},
"additionalProperties": false
}
LoanRepaymentResponse
{
"type": "object",
"properties": {
"month": {
"type": "string",
"x-nullable": true
},
"expectedinvoices": {
"type": "number",
"format": "double",
"x-nullable": true
},
"overdue": {
"type": "number",
"format": "double",
"x-nullable": true
},
"totalAmount": {
"type": "number",
"format": "double",
"readOnly": true,
"x-nullable": true
},
"monthlyLoanRepayments": {
"type": "array",
"items": {
"$ref": "#/definitions/MonthlyLoanRepaymentResponse"
},
"x-nullable": true
}
},
"additionalProperties": false
}
LoanResponse
{
"type": "object",
"properties": {
"closedDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"businessName": {
"type": "string",
"x-nullable": true
},
"customerFullName": {
"type": "string",
"x-nullable": true
},
"applicationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"offerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"closed": {
"type": "boolean",
"x-nullable": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
},
"customerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"partnerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"organisationId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"id": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
LoginRequest
{
"type": "object",
"required": [
"password",
"username"
],
"properties": {
"username": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"minLength": 1
},
"trustedDeviceToken": {
"type": "string",
"x-nullable": true
},
"ipAddress": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
Message
{
"type": "object",
"properties": {
"from": {
"type": "string",
"x-nullable": true
},
"contents": {
"type": "string",
"x-nullable": true
},
"date": {
"type": "string",
"format": "date-time",
"x-nullable": true
}
},
"additionalProperties": false
}
MonthlyLoanRepaymentResponse
{
"type": "object",
"properties": {
"date": {
"type": "string",
"x-nullable": true
},
"amount": {
"type": "number",
"format": "double",
"x-nullable": true
}
},
"additionalProperties": false
}
OfferResponse
{
"type": "object",
"properties": {
"offerId": {
"type": "string",
"format": "uuid",
"x-nullable": true
},
"facilityLimit": {
"type": "number",
"format": "double",
"x-nullable": true
},
"creditLimit": {
"type": "number",
"format": "double",
"x-nullable": true
},
"cashFlowLimit": {
"type": "number",
"format": "double",
"x-nullable": true
},
"receivableLimit": {
"type": "number",
"format": "double",
"x-nullable": true
},
"balance": {
"type": "number",
"format": "double",
"x-nullable": true
},
"availableBalance": {
"type": "number",
"format": "double",
"x-nullable": true
},
"weeklyRepayment": {
"type": "number",
"format": "double",
"x-nullable": true
}
},
"additionalProperties": false
}
PagedListAdvanceProjectionResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/AdvanceProjectionResponse"
},
"x-nullable": true
},
"totalCount": {
"type": "integer",
"format": "int64",
"x-nullable": true
}
},
"additionalProperties": false
}
PagedListTransactionResponse
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/definitions/Transaction"
},
"x-nullable": true
},
"totalCount": {
"type": "integer",
"format": "int64",
"x-nullable": true
}
},
"additionalProperties": false
}
PrimaryApplicantRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"driversLicense": {
"$ref": "#/definitions/DrivingLicenseRequest"
},
"email": {
"type": "string",
"x-nullable": true
},
"mobile": {
"type": "string",
"x-nullable": true
},
"miscellaneousData": {
"type": "object",
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-nullable": true
}
},
"additionalProperties": false
}
ProblemDetails
{
"type": "object",
"properties": {
"type": {
"type": "string",
"x-nullable": true
},
"title": {
"type": "string",
"x-nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"x-nullable": true
},
"detail": {
"type": "string",
"x-nullable": true
},
"instance": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": {}
}
PublicApiApplicantResponse
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"isPrimary": {
"type": "boolean",
"x-nullable": true
},
"email": {
"type": "string",
"x-nullable": true
},
"mobile": {
"type": "string",
"x-nullable": true
},
"applicationId": {
"type": "string",
"x-nullable": true
},
"applicantId": {
"type": "string",
"format": "uuid"
}
},
"additionalProperties": false
}
PublicApiBankFeedAccountResponse
{
"type": "object",
"properties": {
"isConnected": {
"type": "boolean",
"x-nullable": true
},
"archived": {
"type": "boolean",
"x-nullable": true
},
"enabled": {
"type": "boolean",
"x-nullable": true
},
"slug": {
"type": "string",
"x-nullable": true
},
"accountType": {
"type": "string",
"x-nullable": true
},
"accountHolder": {
"type": "string",
"x-nullable": true
},
"available": {
"type": "string",
"x-nullable": true
},
"balance": {
"type": "string",
"x-nullable": true
},
"bsb": {
"type": "string",
"x-nullable": true
},
"id": {
"type": "string",
"x-nullable": true
},
"accountNumber": {
"type": "string",
"x-nullable": true
},
"name": {
"type": "string",
"x-nullable": true
},
"institutionName": {
"type": "string",
"x-nullable": true
},
"institutionId": {
"type": "string",
"x-nullable": true
},
"selected": {
"type": "boolean",
"x-nullable": true
},
"requestId": {
"type": "string",
"x-nullable": true
},
"accountId": {
"type": "string",
"x-nullable": true
},
"routingNumber": {
"type": "string",
"x-nullable": true
},
"isPrimary": {
"type": "boolean",
"x-nullable": true
}
},
"additionalProperties": false
}
SecondaryApplicantRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"driversLicense": {
"$ref": "#/definitions/DrivingLicenseRequest"
},
"email": {
"type": "string",
"x-nullable": true
},
"mobile": {
"type": "string",
"x-nullable": true
},
"miscellaneousData": {
"type": "object",
"additionalProperties": {
"type": "string",
"x-nullable": true
},
"x-nullable": true
}
},
"additionalProperties": false
}
SignaturesRequest
{
"type": "object",
"properties": {
"ipAddress": {
"type": "string",
"x-nullable": true
},
"signature": {
"type": "string",
"format": "byte",
"x-nullable": true
},
"signature2": {
"type": "string",
"format": "byte",
"x-nullable": true
},
"mimeType": {
"type": "string",
"x-nullable": true
},
"secondaryApplicant": {
"type": "boolean"
}
},
"additionalProperties": false
}
SliderRequest
{
"type": "object",
"properties": {
"amount": {
"type": "number",
"format": "double"
}
},
"additionalProperties": false
}
SliderResult
{
"type": "object",
"properties": {
"percentageOfIncome": {
"type": "number",
"format": "double"
},
"position": {
"type": "integer",
"format": "int32"
},
"term": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
}
SupportDocumentDetails
{
"type": "object",
"properties": {
"details": {
"type": "string",
"x-nullable": true
},
"forSecondaryAlso": {
"type": "boolean"
},
"id": {
"type": "string",
"format": "uuid"
},
"label": {
"type": "string",
"x-nullable": true
},
"locations": {
"type": "array",
"items": {
"$ref": "#/definitions/FileDetails"
},
"x-nullable": true
},
"submitted": {
"type": "boolean"
},
"submittedDate": {
"type": "string",
"format": "date-time",
"x-nullable": true
}
},
"additionalProperties": false
}
Transaction
{
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string",
"x-nullable": true
},
"type": {
"type": "string",
"x-nullable": true
},
"amount": {
"$ref": "#/definitions/AmountResponse"
},
"isCredit": {
"type": "boolean"
},
"balance": {
"$ref": "#/definitions/AmountResponse"
}
},
"additionalProperties": false
}
TransactionRequest
{
"type": "object",
"required": [
"amount",
"date",
"isCredit"
],
"properties": {
"amount": {
"type": "number",
"format": "double"
},
"balance": {
"type": "number",
"format": "double",
"x-nullable": true
},
"date": {
"type": "string",
"format": "date-time"
},
"text": {
"type": "string",
"x-nullable": true
},
"isCredit": {
"type": "boolean"
}
},
"additionalProperties": false
}
TwoFactorLoginRequest
{
"type": "object",
"required": [
"code",
"username"
],
"properties": {
"username": {
"type": "string",
"minLength": 1
},
"code": {
"type": "string",
"minLength": 1
},
"ipAddress": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
UserDepartment
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"isEnabled": {
"type": "boolean"
},
"name": {
"type": "string",
"x-nullable": true
},
"normalizedName": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
UserRequest
{
"type": "object",
"required": [
"email",
"firstName",
"lastName",
"mobileNumber"
],
"properties": {
"firstName": {
"type": "string",
"minLength": 1
},
"lastName": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"x-nullable": true
},
"mobileNumber": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
UserResponse
{
"type": "object",
"required": [
"email",
"firstName",
"lastName",
"mobileNumber"
],
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"firstName": {
"type": "string",
"minLength": 1
},
"lastName": {
"type": "string",
"minLength": 1
},
"email": {
"type": "string",
"minLength": 1
},
"password": {
"type": "string",
"x-nullable": true
},
"mobileNumber": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}
ValidationError
{
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"x-nullable": true
},
"errorMessage": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
ValidationProblemDetails
{
"type": "object",
"properties": {
"errors": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"x-nullable": true
},
"type": {
"type": "string",
"x-nullable": true
},
"title": {
"type": "string",
"x-nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"x-nullable": true
},
"detail": {
"type": "string",
"x-nullable": true
},
"instance": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": {}
}
WebhookPayload
{
"type": "object",
"properties": {
"id": {
"type": "string",
"x-nullable": true
},
"webhookEvent": {
"type": "string",
"x-nullable": true
},
"data": {
"x-nullable": true
},
"creationTimeUtc": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
WebhookSubscription
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"webhookUri": {
"type": "string",
"x-nullable": true
},
"secret": {
"type": "string",
"x-nullable": true
},
"isActive": {
"type": "boolean"
},
"webhooks": {
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true
}
},
"additionalProperties": false
}
WebhookSubscriptionSummary
{
"type": "object",
"properties": {
"ownerId": {
"type": "string",
"format": "uuid"
},
"ownerType": {
"type": "string",
"x-nullable": true
},
"ownerName": {
"type": "string",
"x-nullable": true
},
"ownerEmail": {
"type": "string",
"x-nullable": true
},
"subscriptionId": {
"type": "string",
"format": "uuid"
},
"webhookUri": {
"type": "string",
"x-nullable": true
},
"secret": {
"type": "string",
"x-nullable": true
},
"isActive": {
"type": "boolean"
},
"webhooks": {
"type": "array",
"items": {
"type": "string"
},
"x-nullable": true
}
},
"additionalProperties": false
}
WithdrawInvoiceRequestData
{
"type": "object",
"properties": {
"dateUTC": {
"type": "string",
"format": "date-time"
},
"amount": {
"type": "number",
"format": "double"
},
"advanceRate": {
"type": "number",
"format": "double"
},
"otp": {
"type": "string",
"x-nullable": true
}
},
"additionalProperties": false
}
