API reference

Plexe Public API documentation

Find an endpoint, check its parameters and explore request and response examples for your integration.

New to the API? Make your first request, then follow the application walkthrough.

Open Swagger UI · Swagger JSON · All model schemas

Examples below illustrate the bundled Swagger structure. Replace placeholders and check the validation rules before sending requests. Recursive values are shown as null. Some legacy response schemas are incomplete; the guides identify known differences.

79 endpoints 13 groups 71 models

POST

AddOrUpdateBankingData

/api/Application/add-or-update-banking-data/{applicationId}

Operation: AddOrUpdateBankingData
Request: BankingDataRequest
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`bankName`	query	`string`	No	-
`body`	body	`BankingDataRequest`	No	-

Request structure JSON

{
  "bankAccounts": [
    {
      "bank": "string",
      "availableBalance": "string",
      "currentBalance": "string",
      "accountNumber": "string",
      "routing": "string",
      "accountType": "string",
      "transactions": [
        {
          "amount": 123.45,
          "balance": 123.45,
          "date": "2026-04-29T00:00:00Z",
          "text": "string",
          "isCredit": true
        }
      ],
      "accountName": "string"
    }
  ]
}

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

GET

For Application Offer

/api/Application/application-offer/{applicationId}

Operation: ApplicationOffer
Request: No request body
Response: OfferResponse

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	applicationId.
`force`	query	`boolean`	No	force.

Request structure JSON

No request body

Response structure 200

{
  "offerId": "00000000-0000-0000-0000-000000000000",
  "facilityLimit": 123.45,
  "creditLimit": 123.45,
  "cashFlowLimit": 123.45,
  "receivableLimit": 123.45,
  "balance": 123.45,
  "availableBalance": 123.45,
  "weeklyRepayment": 123.45
}

Documented responses

Status	Schema	Description
200	`OfferResponse`	OK
400	`ProblemDetails`	Bad Request

GET

Get Application Status

/api/Application/application-status/{applicationId}

Operation: ApplicationStatus
Request: No request body
Response: string

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	applicationId

Request structure JSON

No request body

Response structure 200

"string"

Documented responses

Status	Schema	Description
200	`string`	OK
400	`ProblemDetails`	Bad Request

POST

Cancel application.

/api/Application/cancel-application/{applicationId}

Operation: CancelApplication
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	applicationId.

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

Create Application

/api/Application/create-application

Operation: CreateApplication
Request: ApplicationRequest
Response: string (uuid)

Parameter	In	Type	Required	Description
`sendLink`	query	`boolean`	No	sendLink
`body`	body	`ApplicationRequest`	Yes	applicationRequest

Request structure JSON

{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "agentId": "00000000-0000-0000-0000-000000000000",
  "businessZip": "string",
  "businessName": "string",
  "extraInformation": {}
}

Response structure 200

"00000000-0000-0000-0000-000000000000"

Documented responses

Status	Schema	Description
200	`string (uuid)`	OK
400	`ValidationProblemDetails`	Bad Request

POST

Create Application

/api/Application/create-application-and-applicant

Operation: CreateApplicationAndApplicant
Request: ApplicationAndApplicantRequest
Response: string (uuid)

Parameter	In	Type	Required	Description
`sendLink`	query	`boolean`	No	sendLink
`body`	body	`ApplicationAndApplicantRequest`	Yes	applicationRequest

Request structure JSON

{
  "applicant": {
    "firstName": "string",
    "lastName": "string",
    "city": "string",
    "state": "string",
    "address": "string",
    "dateOfBirth": "2026-04-29T00:00:00Z"
  },
  "customerId": "00000000-0000-0000-0000-000000000000",
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "agentId": "00000000-0000-0000-0000-000000000000",
  "businessZip": "string",
  "businessName": "string",
  "extraInformation": {}
}

Response structure 200

"00000000-0000-0000-0000-000000000000"

Documented responses

Status	Schema	Description
200	`string (uuid)`	OK
400	`ValidationProblemDetails`	Bad Request

POST

Create Customer

/api/Application/create-customer

Operation: CreateCustomer
Request: UserRequest
Response: UserResponse

Parameter	In	Type	Required	Description
`body`	body	`UserRequest`	Yes	user

Request structure JSON

{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "mobileNumber": "string"
}

Response structure 200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "password": "string",
  "mobileNumber": "string"
}

Documented responses

Status	Schema	Description
200	`UserResponse`	OK
400	`ProblemDetails`	Bad Request

POST

Create new customer and application

Deprecated

/api/Application/create-customer-and-application

before creating it will validate

Operation: CreateCustomerAndApplication
Request: ApplicationAndCustomerRequest
Response: ApplicationCustomerResponse

Parameter	In	Type	Required	Description
`sendLink`	query	`boolean`	No	sendLink
`body`	body	`ApplicationAndCustomerRequest`	Yes	applicationAndCustomer

Request structure JSON

{
  "application": {
    "businessName": "string",
    "businessZip": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "extraInformation": {},
    "notes": [
      "string"
    ]
  },
  "customer": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "password": "string",
    "mobileNumber": "string"
  }
}

Response structure 200

{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "applicationId": "00000000-0000-0000-0000-000000000000",
  "applicantId": "00000000-0000-0000-0000-000000000000",
  "secondaryApplicantId": "00000000-0000-0000-0000-000000000000",
  "organisationId": "00000000-0000-0000-0000-000000000000"
}

Documented responses

Status	Schema	Description
200	`ApplicationCustomerResponse`	OK
400	`ValidationProblemDetails`	Bad Request

POST

Create application with applicant

/api/Application/create-customer-and-application-and-applicant

Operation: CreateCustomerAndApplicationAndApplicant
Request: ApplicationAndCustomerAndApplicantRequest
Response: ApplicationCustomerResponse

Parameter	In	Type	Required	Description
`sendLink`	query	`boolean`	No	-
`body`	body	`ApplicationAndCustomerAndApplicantRequest`	Yes	-

Request structure JSON

{
  "applicant": {
    "firstName": "string",
    "lastName": "string",
    "city": "string",
    "state": "string",
    "address": "string",
    "dateOfBirth": "2026-04-29T00:00:00Z"
  },
  "secondaryApplicant": {
    "firstName": "string",
    "lastName": "string",
    "city": "string",
    "state": "string",
    "address": "string",
    "dateOfBirth": "2026-04-29T00:00:00Z"
  },
  "application": {
    "businessName": "string",
    "businessZip": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "extraInformation": {},
    "notes": [
      "string"
    ]
  },
  "customer": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "password": "string",
    "mobileNumber": "string"
  }
}

Response structure 200

{
  "customerId": "00000000-0000-0000-0000-000000000000",
  "applicationId": "00000000-0000-0000-0000-000000000000",
  "applicantId": "00000000-0000-0000-0000-000000000000",
  "secondaryApplicantId": "00000000-0000-0000-0000-000000000000",
  "organisationId": "00000000-0000-0000-0000-000000000000"
}

Documented responses

Status	Schema	Description
200	`ApplicationCustomerResponse`	OK
400	`ValidationProblemDetails`	Bad Request

GET

Get Application Based on Application Id

/api/Application/get-application/{applicationId}

Operation: GetApplication
Request: No request body
Response: Application

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	applicationId

Request structure JSON

No request body

Response structure 200

{
  "secondaryApplicantRequested": true,
  "primaryApplicantAdded": true,
  "secondaryApplicantAdded": true,
  "loanType": "string",
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "businessName": "string",
  "customerEmail": "string",
  "shortCode": "string",
  "statusName": "string",
  "createdDate": "2026-04-29T00:00:00Z",
  "lastUpdatedDate": "2026-04-29T00:00:00Z",
  "organisationId": "00000000-0000-0000-0000-000000000000",
  "offerId": "00000000-0000-0000-0000-000000000000",
  "agentId": "00000000-0000-0000-0000-000000000000",
  "secured": true,
  "tradingName": "string",
  "fullBusinessName": "string",
  "offerAccepted": true,
  "id": "00000000-0000-0000-0000-000000000000"
}

Documented responses

Status	Schema	Description
200	`Application`	OK
400	`ProblemDetails`	Bad Request

GET

Get Customer Applications Based on Customer Id.

/api/Application/get-customer-applications/{customerId}

Operation: GetCustomerApplications
Request: No request body
Response: Application[]

Parameter	In	Type	Required	Description
`customerId`	path	`string (uuid)`	Yes	customerId.

Request structure JSON

No request body

Response structure 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "customerEmail": "string",
    "shortCode": "string",
    "statusName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "lastUpdatedDate": "2026-04-29T00:00:00Z",
    "organisationId": "00000000-0000-0000-0000-000000000000",
    "offerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "secured": true,
    "tradingName": "string",
    "fullBusinessName": "string",
    "offerAccepted": true,
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`Application[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get Partner Applications Based on Partner Id.

/api/Application/get-partner-applications/{partnerId}

Operation: GetPartnerApplications
Request: No request body
Response: Application[]

Parameter	In	Type	Required	Description
`partnerId`	path	`string (uuid)`	Yes	partnerId.
`skip`	query	`integer (int32)`	No	skip.
`take`	query	`integer (int32)`	No	take.

Request structure JSON

No request body

Response structure 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "customerEmail": "string",
    "shortCode": "string",
    "statusName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "lastUpdatedDate": "2026-04-29T00:00:00Z",
    "organisationId": "00000000-0000-0000-0000-000000000000",
    "offerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "secured": true,
    "tradingName": "string",
    "fullBusinessName": "string",
    "offerAccepted": true,
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`Application[]`	OK
400	`ProblemDetails`	Bad Request

GET

For Process Application

/api/Application/process-application/{applicationId}

Operation: ProcessApplication
Request: No request body
Response: string (uuid)

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	applicationId

Request structure JSON

No request body

Response structure 200

"00000000-0000-0000-0000-000000000000"

Documented responses

Status	Schema	Description
200	`string (uuid)`	OK
400	`ProblemDetails`	Bad Request

POST

Quick Test

/api/Application/quick-test/{applicationId}

Operation: QuickTest
Request: BankingDataRequest
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`body`	body	`BankingDataRequest`	No	-

Request structure JSON

{
  "bankAccounts": [
    {
      "bank": "string",
      "availableBalance": "string",
      "currentBalance": "string",
      "accountNumber": "string",
      "routing": "string",
      "accountType": "string",
      "transactions": [
        {
          "amount": 123.45,
          "balance": 123.45,
          "date": "2026-04-29T00:00:00Z",
          "text": "string",
          "isCredit": true
        }
      ],
      "accountName": "string"
    }
  ]
}

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

POST

Send application link

/api/Application/send-application-link

Operation: SendApplicationLink
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	query	`string (uuid)`	No	Application Id

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

Submit Bank statement document.

/api/Application/submit-bankstatement-document/{applicationId}

Operation: SubmitBankStatementDocument
Request: string (byte)
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`fileName`	query	`string`	Yes	-
`body`	body	`string (byte)`	Yes	-

Request structure JSON

"ZXhhbXBsZQ=="

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

GET

UpdateApplicationData

/api/Application/update-application-data/{applicationId}

Operation: UpdateApplicationData
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`name`	query	`string`	Yes	-
`zipcode`	query	`string`	Yes	-
`startDate`	query	`string (date-time)`	Yes	-

Request structure JSON

No request body

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

GET

UpdateApplicationNameAndZipCode

/api/Application/update-application-name-and-zip-code/{applicationId}

Operation: UpdateApplicationNameAndZipCode
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`name`	query	`string`	No	-
`zipCode`	query	`string`	No	-

Request structure JSON

No request body

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

GET

UpdateApplicationName

/api/Application/update-application-name/{applicationId}

Operation: UpdateApplicationName
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`name`	query	`string`	No	-

Request structure JSON

No request body

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

GET

UpdateCustomerData

/api/Application/update-customer-data/{applicationId}

Operation: UpdateCustomerData
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`firstname`	query	`string`	Yes	-
`lastname`	query	`string`	Yes	-
`address`	query	`string`	Yes	-
`state`	query	`string`	Yes	-
`city`	query	`string`	Yes	-
`ssn`	query	`string`	Yes	-
`mobile`	query	`string`	Yes	-
`dateOfBirth`	query	`string (date-time)`	Yes	-

Request structure JSON

No request body

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

POST

Add company details

/api/ApplicationApproval/add-company-details/{applicationId}

Operation: AddCompanyDetails
Request: CompanyDataRequest
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id
`body`	body	`CompanyDataRequest`	Yes	Company Data

Request structure JSON

{
  "businessName": "string",
  "entityType": "string",
  "zipCode": "string",
  "businessTaxId": "string",
  "city": "string"
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

Add primary applicant details

/api/ApplicationApproval/add-primary-applicant-details/{applicationId}

Operation: AddPrimaryApplicantDetails
Request: PrimaryApplicantRequest
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id
`body`	body	`PrimaryApplicantRequest`	Yes	Applicant

Request structure JSON

{
  "name": "string",
  "driversLicense": {
    "issuingState": "string",
    "cardNumber": "string",
    "expiryDate": "2026-04-29T00:00:00Z",
    "name": "string",
    "address": "string",
    "dateOfBirth": "2026-04-29T00:00:00Z",
    "city": "string"
  },
  "email": "string",
  "mobile": "string",
  "miscellaneousData": {}
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

Add secondary applicant details

/api/ApplicationApproval/add-secondary-applicant-details/{applicationId}

Operation: AddSecondaryApplicantDetails
Request: SecondaryApplicantRequest
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id
`body`	body	`SecondaryApplicantRequest`	Yes	Applicant

Request structure JSON

{
  "name": "string",
  "driversLicense": {
    "issuingState": "string",
    "cardNumber": "string",
    "expiryDate": "2026-04-29T00:00:00Z",
    "name": "string",
    "address": "string",
    "dateOfBirth": "2026-04-29T00:00:00Z",
    "city": "string"
  },
  "email": "string",
  "mobile": "string",
  "miscellaneousData": {}
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

GET

Get all applicants

/api/ApplicationApproval/get-all-applicants/{applicationId}

Operation: GetAllApplicants
Request: No request body
Response: PublicApiApplicantResponse[]

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

[
  {
    "name": "string",
    "isPrimary": true,
    "email": "string",
    "mobile": "string",
    "applicationId": "string",
    "applicantId": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`PublicApiApplicantResponse[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get all banks

/api/ApplicationApproval/get-all-bank-accounts/{applicationId}

Operation: GetAllBankAccounts
Request: No request body
Response: PublicApiBankFeedAccountResponse[]

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

[
  {
    "isConnected": true,
    "archived": true,
    "enabled": true,
    "slug": "string",
    "accountType": "string",
    "accountHolder": "string",
    "available": "string",
    "balance": "string",
    "bsb": "string",
    "id": "string",
    "accountNumber": "string",
    "name": "string",
    "institutionName": "string",
    "institutionId": "string",
    "selected": true,
    "requestId": "string",
    "accountId": "string",
    "routingNumber": "string",
    "isPrimary": true
  }
]

Documented responses

Status	Schema	Description
200	`PublicApiBankFeedAccountResponse[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get contracts against application id.

/api/ApplicationApproval/get-contract-details/{applicationId}

Operation: GetContractsDetails
Request: No request body
Response: ContractDetails[]

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id

Request structure JSON

No request body

Response structure 200

[
  {
    "companyName": "string",
    "guarantors": "string",
    "facilityLimit": 123.45,
    "establishmentFee": "string",
    "drawFee": "string",
    "bankAccounts": [
      {
        "name": "string",
        "accountNumber": "string",
        "routingNumber": "string"
      }
    ],
    "platformAgreementHTML": "string",
    "platformAgreementSignCondition1": "string",
    "platformAgreementSignCondition2": "string"
  }
]

Documented responses

Status	Schema	Description
200	`ContractDetails[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get contracts of application

/api/ApplicationApproval/get-contracts/{applicationId}

Operation: GetContracts
Request: No request body
Response: ContractDocumentResponse[]

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id

Request structure JSON

No request body

Response structure 200

[
  {
    "displayName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "documentId": "00000000-0000-0000-0000-000000000000",
    "data": "ZXhhbXBsZQ==",
    "status": 0
  }
]

Documented responses

Status	Schema	Description
200	`ContractDocumentResponse[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get primary bank account

/api/ApplicationApproval/get-primary-bank-account/{applicationId}

Operation: GetPrimaryBankAccount
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

GET

Get required documents

/api/ApplicationApproval/get-required-documents/{applicationId}

Operation: GetRequiredDocuments
Request: No request body
Response: SupportDocumentDetails[]

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id

Request structure JSON

No request body

Response structure 200

[
  {
    "details": "string",
    "forSecondaryAlso": true,
    "id": "00000000-0000-0000-0000-000000000000",
    "label": "string",
    "locations": [
      {
        "date": "2026-04-29T00:00:00Z",
        "fileDateStr": "string",
        "fileName": "string",
        "fileType": "string",
        "internalLocation": "string",
        "isSecondary": true,
        "location": "string",
        "missingTransaction": true
      }
    ],
    "submitted": true,
    "submittedDate": "2026-04-29T00:00:00Z"
  }
]

Documented responses

Status	Schema	Description
200	`SupportDocumentDetails[]`	OK
400	`ProblemDetails`	Bad Request

POST

Set primary bank account

/api/ApplicationApproval/set-primary-bank-account/{applicationId}/{id}

Operation: SetPrimaryBankAccount
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id
`id`	path	`string`	Yes	Id of account that need to set as primary

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

Sign contract by applicant

/api/ApplicationApproval/sign-contract/{applicationId}/{applicantId}

Operation: SignContract
Request: SignaturesRequest
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	Application Id
`applicantId`	path	`string (uuid)`	Yes	Applicant Id
`body`	body	`SignaturesRequest`	No	Signatures

Request structure JSON

{
  "ipAddress": "string",
  "signature": "ZXhhbXBsZQ==",
  "signature2": "ZXhhbXBsZQ==",
  "mimeType": "string",
  "secondaryApplicant": true
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

SubmitDocument

/api/ApplicationApproval/submit-document/{applicationId}

Operation: SubmitDocument
Request: string (byte)
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`fileType`	query	`string`	Yes	-
`fileName`	query	`string`	Yes	-
`body`	body	`string (byte)`	Yes	-

Request structure JSON

"ZXhhbXBsZQ=="

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

SubmitRequiredDocument

/api/ApplicationApproval/submit-required-document/{applicationId}

Operation: SubmitRequiredDocument
Request: string (byte)
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	-
`supportingDocumentId`	query	`string (uuid)`	Yes	-
`fileType`	query	`string`	Yes	-
`fileName`	query	`string`	Yes	-
`body`	body	`string (byte)`	Yes	-

Request structure JSON

"ZXhhbXBsZQ=="

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

Create applications in bulk

/api/ApplicationBulk/create-applications

Operation: CreateApplications
Request: ApplicationRequest[]
Response: ApplicationResponse[]

Parameter	In	Type	Required	Description
`body`	body	`ApplicationRequest[]`	Yes	applications

Request structure JSON

[
  {
    "customerId": "00000000-0000-0000-0000-000000000000",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "businessZip": "string",
    "businessName": "string",
    "extraInformation": {}
  }
]

Response structure 200

[
  {
    "applicationId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "businessZip": "string",
    "businessName": "string",
    "extraInformation": {}
  }
]

Documented responses

Status	Schema	Description
200	`ApplicationResponse[]`	OK
400	`ValidationProblemDetails`	Bad Request

POST

Create Customers in bulk

/api/ApplicationBulk/create-customers

Operation: CreateCustomers
Request: UserRequest[]
Response: UserResponse[]

Parameter	In	Type	Required	Description
`body`	body	`UserRequest[]`	Yes	users

Request structure JSON

[
  {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "password": "string",
    "mobileNumber": "string"
  }
]

Response structure 200

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "password": "string",
    "mobileNumber": "string"
  }
]

Documented responses

Status	Schema	Description
200	`UserResponse[]`	OK
400	`ProblemDetails`	Bad Request

POST

You will need to provide the username and password to get the bearer token.

/api/Authenication/login

Operation: Login
Request: LoginRequest
Response: FullApplicationUser

Parameter	In	Type	Required	Description
`body`	body	`LoginRequest`	No	Credentials supplied in the JSON request body.

Request structure JSON

{
  "username": "string",
  "password": "string",
  "trustedDeviceToken": "string",
  "ipAddress": "string"
}

Response structure 200

{
  "avatarVersion": "string",
  "departments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "name": "string",
      "normalizedName": "string"
    }
  ],
  "email": "string",
  "expiresUTC": "2026-04-29T00:00:00Z",
  "firstName": "string",
  "firstTime": true,
  "hasAvatar": true,
  "id": "string",
  "impersonationSessionId": "00000000-0000-0000-0000-000000000000",
  "impersonatorEmail": "string",
  "impersonatorId": "string",
  "impersonatorName": "string",
  "isImpersonating": true,
  "lastName": "string",
  "phoneRegion": "string",
  "requiresTwoFactor": true,
  "timeZoneId": "string",
  "token": "string",
  "trustedDeviceToken": "string",
  "userType": "string",
  "username": "string"
}

Documented responses

Status	Schema	Description
200	`FullApplicationUser`	OK
400	`ProblemDetails`	Bad Request

POST

Refresh an authenticated bearer token

/api/Authenication/refresh-token

Requires an accepted bearer token. Renew before expiry; sign in again if authentication rejects the token.

Operation: RefreshToken
Request: No request body
Response: string

Request structure JSON

No request body

Response structure 200

"string"

Documented responses

Status	Schema	Description
200	`string`	OK
400	`ProblemDetails`	Bad Request

POST

Validates the two-factor code generated during login.

/api/Authenication/validate-two-factor

Operation: ValidateTwoFactor
Request: TwoFactorLoginRequest
Response: FullApplicationUser

Parameter	In	Type	Required	Description
`body`	body	`TwoFactorLoginRequest`	No	Two-factor verification request.

Request structure JSON

{
  "username": "string",
  "code": "string",
  "ipAddress": "string"
}

Response structure 200

{
  "avatarVersion": "string",
  "departments": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "name": "string",
      "normalizedName": "string"
    }
  ],
  "email": "string",
  "expiresUTC": "2026-04-29T00:00:00Z",
  "firstName": "string",
  "firstTime": true,
  "hasAvatar": true,
  "id": "string",
  "impersonationSessionId": "00000000-0000-0000-0000-000000000000",
  "impersonatorEmail": "string",
  "impersonatorId": "string",
  "impersonatorName": "string",
  "isImpersonating": true,
  "lastName": "string",
  "phoneRegion": "string",
  "requiresTwoFactor": true,
  "timeZoneId": "string",
  "token": "string",
  "trustedDeviceToken": "string",
  "userType": "string",
  "username": "string"
}

Documented responses

Status	Schema	Description
200	`FullApplicationUser`	OK
400	`ProblemDetails`	Bad Request

POST

Application Invoice Calculation

/api/Calculation/application-invoice-calculation

Operation: CalculateInvoice
Request: CalculationRequest
Response: CalculationResponse

Parameter	In	Type	Required	Description
`applicationId`	query	`string (uuid)`	Yes	applicationId
`body`	body	`CalculationRequest`	No	calculationRequest

Request structure JSON

{
  "amount": 123.45,
  "percentOfIncome": 123.45,
  "terms": 123,
  "fixedRepaymentCalculation": true
}

Response structure 200

{
  "advanceRate": 123.45,
  "totalRepayment": 123.45,
  "repayment": 123.45,
  "advanceFee": 123.45,
  "weeks": 123,
  "amount": 123.45,
  "percentOfIncome": 123.45,
  "terms": 123,
  "fixedRepaymentCalculation": true
}

Documented responses

Status	Schema	Description
200	`CalculationResponse`	OK
400	`ProblemDetails`	Bad Request

POST

Application Line of credit calculation.

/api/Calculation/application-loc-calculation

Operation: CalculateLOC
Request: CalculationRequest
Response: CalculationResponse

Parameter	In	Type	Required	Description
`applicationId`	query	`string (uuid)`	Yes	applicationId
`body`	body	`CalculationRequest`	No	calculationRequest

Request structure JSON

{
  "amount": 123.45,
  "percentOfIncome": 123.45,
  "terms": 123,
  "fixedRepaymentCalculation": true
}

Response structure 200

{
  "advanceRate": 123.45,
  "totalRepayment": 123.45,
  "repayment": 123.45,
  "advanceFee": 123.45,
  "weeks": 123,
  "amount": 123.45,
  "percentOfIncome": 123.45,
  "terms": 123,
  "fixedRepaymentCalculation": true
}

Documented responses

Status	Schema	Description
200	`CalculationResponse`	OK
400	`ProblemDetails`	Bad Request

POST

For LOC Calculation Slider

/api/Calculation/application-loc-calculation-slider

Operation: CalculateLOCSlider
Request: SliderRequest
Response: SliderResult[]

Parameter	In	Type	Required	Description
`applicationId`	query	`string (uuid)`	Yes	applicationId
`body`	body	`SliderRequest`	No	applicationId

Request structure JSON

{
  "amount": 123.45
}

Response structure 200

[
  {
    "percentageOfIncome": 123.45,
    "position": 123,
    "term": 123
  }
]

Documented responses

Status	Schema	Description
200	`SliderResult[]`	OK
400	`ProblemDetails`	Bad Request

GET

For Getting all messages

/api/Communication/get-all-messages/{applicationId}

Operation: GetAllMessages
Request: No request body
Response: Message[]

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	applicationId
`skip`	query	`integer (int32)`	No	skip
`take`	query	`integer (int32)`	No	take

Request structure JSON

No request body

Response structure 200

[
  {
    "from": "string",
    "contents": "string",
    "date": "2026-04-29T00:00:00Z"
  }
]

Documented responses

Status	Schema	Description
200	`Message[]`	OK
400	`ProblemDetails`	Bad Request

POST

For Post Message.

/api/Communication/post-messages/{applicationId}

Operation: PostMessage
Request: CommunicationRequest
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`applicationId`	path	`string (uuid)`	Yes	applicationId.
`body`	body	`CommunicationRequest`	No	communicationRequest.

Request structure JSON

{
  "contents": "string",
  "user": "string"
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

GET

Get Customer by Email

/api/Customer/get-customer-by-email

Operation: GetCustomerByEmail
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`email`	query	`string`	Yes	Customer email

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

GET

Get Customer by Id

/api/Customer/get-customer-by-id/{customerId}

Operation: GetCustomerById
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`customerId`	path	`string (uuid)`	Yes	Customer Id

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

GET

For get invoice of customer based on loan id

/api/InvoiceCustomer/get-invoice-customer/{loanId}

Operation: GetInvoiceCustomers
Request: No request body
Response: InvoiceCustomer[]

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId
`skip`	query	`integer (int32)`	No	skip
`take`	query	`integer (int32)`	No	take

Request structure JSON

No request body

Response structure 200

[
  {
    "data": [
      {
        "name": "string",
        "id": "string",
        "details": {
          "name": "string",
          "invoiceTypes": {}
        },
        "approved": 123.45,
        "fundingRate": 123.45,
        "available": 123.45,
        "selected": true,
        "requested": true,
        "total": 123.45,
        "adminSelected": true
      }
    ],
    "totalCount": 123
  }
]

Documented responses

Status	Schema	Description
200	`InvoiceCustomer[]`	OK
400	`ProblemDetails`	Bad Request

POST

Enable Invoice

/api/InvoiceCustomer/request-enable/{loanId}

Operation: RequestEnableInvoiceCustomers
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId
`invoiceCustomerId`	query	`string`	Yes	invoiceCustomerId

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

POST

Confirm withdrawal invoice by loan Id

/api/Loan/confirm-withdrawal-invoice/{loanId}

Operation: ConfirmWithdrawalInvoice
Request: WithdrawInvoiceRequestData
Response: GuidApiResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId
`body`	body	`WithdrawInvoiceRequestData`	No	request

Request structure JSON

{
  "dateUTC": "2026-04-29T00:00:00Z",
  "amount": 123.45,
  "advanceRate": 123.45,
  "otp": "string"
}

Response structure 200

{
  "errors": [
    {
      "errorCode": "string",
      "errorMessage": "string"
    }
  ],
  "data": "00000000-0000-0000-0000-000000000000",
  "success": true,
  "message": "string"
}

Documented responses

Status	Schema	Description
200	`GuidApiResponse`	OK
400	`ProblemDetails`	Bad Request

GET

Get Contract Document By Loan Id

/api/Loan/get-contract-documents/{loanId}

Operation: GetContractDocuments
Request: No request body
Response: ContractDocumentResponse[]

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId

Request structure JSON

No request body

Response structure 200

[
  {
    "displayName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "documentId": "00000000-0000-0000-0000-000000000000",
    "data": "ZXhhbXBsZQ==",
    "status": 0
  }
]

Documented responses

Status	Schema	Description
200	`ContractDocumentResponse[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get Customer Loan By Customer Id

/api/Loan/get-customer-loans/{customerId}

Operation: GetCustomerLoans
Request: No request body
Response: LoanResponse[]

Parameter	In	Type	Required	Description
`customerId`	path	`string (uuid)`	Yes	customerId

Request structure JSON

No request body

Response structure 200

[
  {
    "closedDate": "2026-04-29T00:00:00Z",
    "businessName": "string",
    "customerFullName": "string",
    "applicationId": "00000000-0000-0000-0000-000000000000",
    "offerId": "00000000-0000-0000-0000-000000000000",
    "closed": true,
    "createdDate": "2026-04-29T00:00:00Z",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "organisationId": "00000000-0000-0000-0000-000000000000",
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`LoanResponse[]`	OK
400	`ProblemDetails`	Bad Request

GET

For get early repayment based on loan id.

/api/Loan/get-early-repayment/{loanId}

Operation: GetEarlyRepayment
Request: No request body
Response: EarlyRepaymentResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

{
  "amount": 123.45,
  "principal": 123.45,
  "fee": 123.45,
  "notes": "string"
}

Documented responses

Status	Schema	Description
200	`EarlyRepaymentResponse`	OK
400	`ProblemDetails`	Bad Request

GET

For get loan based on loan id

/api/Loan/get-loan/{loanId}

Operation: GetLoan
Request: No request body
Response: Loan

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

{
  "loanId": "00000000-0000-0000-0000-000000000000",
  "secondaryApplicantRequested": true,
  "primaryApplicantAdded": true,
  "secondaryApplicantAdded": true,
  "loanType": "string",
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "businessName": "string",
  "customerEmail": "string",
  "shortCode": "string",
  "statusName": "string",
  "createdDate": "2026-04-29T00:00:00Z",
  "lastUpdatedDate": "2026-04-29T00:00:00Z",
  "organisationId": "00000000-0000-0000-0000-000000000000",
  "offerId": "00000000-0000-0000-0000-000000000000",
  "agentId": "00000000-0000-0000-0000-000000000000",
  "secured": true,
  "tradingName": "string",
  "fullBusinessName": "string",
  "offerAccepted": true,
  "id": "00000000-0000-0000-0000-000000000000"
}

Documented responses

Status	Schema	Description
200	`Loan`	OK
400	`ProblemDetails`	Bad Request

GET

Get Repayment Balances By Loan Id

/api/Loan/get-repayment-balances/{loanId}

Operation: GetRepaymentBalances
Request: No request body
Response: DashboardLoanRepaymentResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId

Request structure JSON

No request body

Response structure 200

{
  "loanRepayments": [
    {
      "month": "string",
      "expectedinvoices": 123.45,
      "overdue": 123.45,
      "totalAmount": 123.45,
      "monthlyLoanRepayments": [
        {
          "date": "string",
          "amount": 123.45
        }
      ]
    }
  ]
}

Documented responses

Status	Schema	Description
200	`DashboardLoanRepaymentResponse`	OK
400	`ProblemDetails`	Bad Request

GET

Get Total Balance By Loan Id

/api/Loan/get-total-balance/{loanId}

Operation: GetTotalBalance
Request: No request body
Response: LoanBalanceResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

{
  "availableFunds": 123.45,
  "systemPricing": 123.45,
  "balance": 123.45,
  "totalLimit": 123.45,
  "limits": {},
  "rawTotal": 123.45,
  "adjustment": 123.45,
  "totalDebtors": 123.45,
  "totalFundingRate": 123.45
}

Documented responses

Status	Schema	Description
200	`LoanBalanceResponse`	OK
400	`ProblemDetails`	Bad Request

GET

GetTransactionsPaged

/api/Loan/get-transactions-paged/{loanId}

Operation: GetTransactionsPaged
Request: No request body
Response: PagedListTransactionResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	-
`skip`	query	`integer (int32)`	No	-
`take`	query	`integer (int32)`	No	-
`descending`	query	`boolean`	No	-

Request structure JSON

No request body

Response structure 200

{
  "data": [
    {
      "date": "2026-04-29T00:00:00Z",
      "description": "string",
      "type": "string",
      "amount": {
        "value": 123.45,
        "currencyCode": "string"
      },
      "isCredit": true,
      "balance": {
        "value": 123.45,
        "currencyCode": "string"
      }
    }
  ],
  "totalCount": 123
}

Documented responses

Status	Schema	Description
200	`PagedListTransactionResponse`	OK
400	`ProblemDetails`	Bad Request

GET

Get Transactions By Loan Id

/api/Loan/get-transactions/{loanId}

Operation: GetTransactions
Request: No request body
Response: Transaction[]

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId
`skip`	query	`integer (int32)`	No	skip
`take`	query	`integer (int32)`	No	take

Request structure JSON

No request body

Response structure 200

[
  {
    "date": "2026-04-29T00:00:00Z",
    "description": "string",
    "type": "string",
    "amount": {
      "value": 123.45,
      "currencyCode": "string"
    },
    "isCredit": true,
    "balance": {
      "value": 123.45,
      "currencyCode": "string"
    }
  }
]

Documented responses

Status	Schema	Description
200	`Transaction[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get Withdrawals by Loan Id

/api/Loan/get-withdrawals/{loanId}

Operation: GetWithdrawals
Request: No request body
Response: PagedListAdvanceProjectionResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId
`skip`	query	`integer (int32)`	No	skip
`take`	query	`integer (int32)`	No	take
`descending`	query	`boolean`	No	by date

Request structure JSON

No request body

Response structure 200

{
  "data": [
    {
      "terms": 123,
      "priority": true,
      "percentage": 123.45,
      "weeks": 123,
      "name": "string",
      "earlyRepaid": true,
      "earlyRepaidDate": "2026-04-29T00:00:00Z",
      "overrideLastRepaymentDateUTC": "2026-04-29T00:00:00Z",
      "overrideLastRepayment": true,
      "legacy": true,
      "monthlyFee": true,
      "commission": {
        "upfrontFee": 123.45,
        "trailing": 123.45,
        "drawFee": 123.45
      },
      "fixedProperty": true,
      "advanceRate": 123.45,
      "weeklyPayment": 123.45,
      "totalRepaymentAmount": 123.45,
      "lastRepaymentDateUTC": "2026-04-29T00:00:00Z",
      "lastRepaymentDay": "string",
      "nextRepaymentDay": "string",
      "actualNextRepaymentDay": "string",
      "actualNextRepaymentDateUTC": "2026-04-29T00:00:00Z",
      "nextRepaymentDateUTC": "2026-04-29T00:00:00Z",
      "nextRepaymentValue": {
        "value": 123.45,
        "currencyCode": "string"
      },
      "remaining": {
        "value": 123.45,
        "currencyCode": "string"
      },
      "amount": {
        "value": 123.45,
        "currencyCode": "string"
      },
      "details": "string",
      "type": "string",
      "dateUTC": "2026-04-29T00:00:00Z",
      "loanId": "00000000-0000-0000-0000-000000000000",
      "id": "00000000-0000-0000-0000-000000000000",
      "fixedRepayment": 123.45,
      "fixedRepaymentFee": 123.45
    }
  ],
  "totalCount": 123
}

Documented responses

Status	Schema	Description
200	`PagedListAdvanceProjectionResponse`	OK
400	`ProblemDetails`	Bad Request

GET

IsLoanClosed

/api/Loan/is-loan-closed/{loanId}

Operation: IsLoanClosed
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

GET

Get enable disable status for loan based on loan Id.

/api/Loan/is-loan-enabled/{loanId}

Operation: IsLoanEnabled
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

true

Documented responses

Status	Schema	Description
200	`boolean`	OK
400	`ProblemDetails`	Bad Request

POST

Make Withdrawal Of Invoice By Loan Id

/api/Loan/make-withdrawal-invoice/{loanId}

Operation: ProcessWithdrawalInvoice
Request: InvoiceWithdrawalRequest
Response: InvoiceWithdrawalResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId
`body`	body	`InvoiceWithdrawalRequest`	No	request

Request structure JSON

{
  "calculation": {
    "amount": 123.45,
    "percentOfIncome": 123.45,
    "terms": 123,
    "fixedRepaymentCalculation": true
  }
}

Response structure 200

{
  "primaryBank": {
    "name": "string",
    "accountNumber": "string",
    "routingNumber": "string"
  },
  "contactNumber": "string",
  "advanceRate": 123.45,
  "applicationId": "00000000-0000-0000-0000-000000000000",
  "firstRepayment": "2026-04-29T00:00:00Z",
  "isfixed": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "isFirstAdavnce": true,
  "loanId": "00000000-0000-0000-0000-000000000000",
  "percentageOfIncome": 123.45,
  "totalRepayment": 123.45,
  "weeklyForecastIncome": 123.45,
  "weeklyRepayment": 123.45,
  "weeks": 123,
  "withdrawAmount": 123.45,
  "otp": "string",
  "calculation": {
    "amount": 123.45,
    "percentOfIncome": 123.45,
    "terms": 123,
    "fixedRepaymentCalculation": true
  }
}

Documented responses

Status	Schema	Description
200	`InvoiceWithdrawalResponse`	OK
400	`ProblemDetails`	Bad Request

POST

Make Withdrawal Of Line Of Credit

/api/Loan/make-withdrawal-line-of-credit/{loanId}

Operation: ProcessWithdrawalLOC
Request: LineOfCreditWithdrawalRequest
Response: LineOfCreditWithdrawalResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	loanId
`body`	body	`LineOfCreditWithdrawalRequest`	No	request

Request structure JSON

{
  "calculation": {
    "amount": 123.45,
    "percentOfIncome": 123.45,
    "terms": 123,
    "fixedRepaymentCalculation": true
  }
}

Response structure 200

{
  "primaryBank": {
    "name": "string",
    "accountNumber": "string",
    "routingNumber": "string"
  },
  "contactNumber": "string",
  "advanceRate": 123.45,
  "applicationId": "00000000-0000-0000-0000-000000000000",
  "firstRepayment": "2026-04-29T00:00:00Z",
  "isfixed": true,
  "id": "00000000-0000-0000-0000-000000000000",
  "isFirstAdavnce": true,
  "loanId": "00000000-0000-0000-0000-000000000000",
  "percentageOfIncome": 123.45,
  "totalRepayment": 123.45,
  "weeklyForecastIncome": 123.45,
  "weeklyRepayment": 123.45,
  "weeks": 123,
  "withdrawAmount": 123.45,
  "otp": "string",
  "calculation": {
    "amount": 123.45,
    "percentOfIncome": 123.45,
    "terms": 123,
    "fixedRepaymentCalculation": true
  }
}

Documented responses

Status	Schema	Description
200	`LineOfCreditWithdrawalResponse`	OK
400	`ProblemDetails`	Bad Request

POST

Resend Withdrawal Otp

/api/Loan/resend-withdrawal-otp/{loanId}

Operation: ResendWithdrawalOtp
Request: No request body
Response: string (uuid)

Parameter	In	Type	Required	Description
`loanId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

"00000000-0000-0000-0000-000000000000"

Documented responses

Status	Schema	Description
200	`string (uuid)`	OK
400	`ProblemDetails`	Bad Request

GET

For Get Industries.

/api/Lookup/get-industries

Operation: GetIndustries
Request: No request body
Response: Industry[]

Request structure JSON

No request body

Response structure 200

[
  {
    "name": "string"
  }
]

Documented responses

Status	Schema	Description
200	`Industry[]`	OK
400	`ProblemDetails`	Bad Request

GET

GetAgentsOnPartner

/api/Partner/get-agents-on-partner/{partnerId}

Operation: GetAgentsOnPartner
Request: No request body
Response: Agent[]

Parameter	In	Type	Required	Description
`partnerId`	path	`string (uuid)`	Yes	-
`deleted`	query	`boolean`	No	-

Request structure JSON

No request body

Response structure 200

[
  {
    "agentId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "ccEmail": "string",
    "city": "string",
    "compliance": true,
    "countryCode": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "deleted": true,
    "deletedDate": "2026-04-29T00:00:00Z",
    "email": "string",
    "enabled": true,
    "firstName": "string",
    "formattedAddress": "string",
    "isMaster": true,
    "lastName": "string",
    "latitude": 123.45,
    "lockoutEnabled": true,
    "longitude": 123.45,
    "mobile": "string",
    "name": "string",
    "notes": [
      {
        "agentId": "00000000-0000-0000-0000-000000000000",
        "author": "string",
        "note": "string",
        "noteCreated": "2026-04-29T00:00:00Z",
        "noteId": "00000000-0000-0000-0000-000000000000"
      }
    ],
    "partnerBusinessName": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "partnerName": "string",
    "postalCode": "string",
    "showTodo": true,
    "state": "string"
  }
]

Documented responses

Status	Schema	Description
200	`Agent[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get Applications On Partner Id.

/api/Partner/get-applications-on-partner-with-filter/{partnerId}

Operation: GetApplicationsOnPartnerWithFilter
Request: No request body
Response: Application[]

Parameter	In	Type	Required	Description
`partnerId`	path	`string (uuid)`	Yes	-
`startDate`	query	`string (date-time)`	No	-
`endDate`	query	`string (date-time)`	No	-

Request structure JSON

No request body

Response structure 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "customerEmail": "string",
    "shortCode": "string",
    "statusName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "lastUpdatedDate": "2026-04-29T00:00:00Z",
    "organisationId": "00000000-0000-0000-0000-000000000000",
    "offerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "secured": true,
    "tradingName": "string",
    "fullBusinessName": "string",
    "offerAccepted": true,
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`Application[]`	OK
400	`ProblemDetails`	Bad Request

GET

GetApplicationsOnPartnerWithLastUpdated

/api/Partner/get-applications-on-partner-with-last-updated/{partnerId}

Operation: GetApplicationsOnPartnerWithLastUpdated
Request: No request body
Response: Application[]

Parameter	In	Type	Required	Description
`partnerId`	path	`string (uuid)`	Yes	-
`startDate`	query	`string (date-time)`	No	-
`endDate`	query	`string (date-time)`	No	-

Request structure JSON

No request body

Response structure 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "customerEmail": "string",
    "shortCode": "string",
    "statusName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "lastUpdatedDate": "2026-04-29T00:00:00Z",
    "organisationId": "00000000-0000-0000-0000-000000000000",
    "offerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "secured": true,
    "tradingName": "string",
    "fullBusinessName": "string",
    "offerAccepted": true,
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`Application[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get Applications On Partner Id.

/api/Partner/get-applications-on-partner/{partnerId}

Operation: GetApplicationsOnPartner
Request: No request body
Response: Application[]

Parameter	In	Type	Required	Description
`partnerId`	path	`string (uuid)`	Yes	-

Request structure JSON

No request body

Response structure 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "customerEmail": "string",
    "shortCode": "string",
    "statusName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "lastUpdatedDate": "2026-04-29T00:00:00Z",
    "organisationId": "00000000-0000-0000-0000-000000000000",
    "offerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "secured": true,
    "tradingName": "string",
    "fullBusinessName": "string",
    "offerAccepted": true,
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`Application[]`	OK
400	`ProblemDetails`	Bad Request

GET

GetLoansAdvancesOnPartner

/api/Partner/get-loans-advances-on-partner/{partnerId}

Operation: GetLoansAdvancesOnPartner
Request: No request body
Response: Advance[]

Parameter	In	Type	Required	Description
`partnerId`	path	`string (uuid)`	Yes	-
`startDate`	query	`string (date-time)`	No	-
`endDate`	query	`string (date-time)`	No	-

Request structure JSON

No request body

Response structure 200

[
  {
    "loanId": "00000000-0000-0000-0000-000000000000",
    "customerEmail": "string",
    "businessName": "string",
    "fullBusinessName": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "amount": 123.45,
    "date": "2026-04-29T00:00:00Z",
    "advanceRate": 123.45,
    "term": 123,
    "isFixedRepayment": true,
    "isPercentageofIncome": true,
    "percentOfIncome": 123.45,
    "advanceId": "00000000-0000-0000-0000-000000000000",
    "customerName": "string",
    "customerId": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`Advance[]`	OK
400	`ProblemDetails`	Bad Request

GET

Get Loans On Partner Id.

/api/Partner/get-loans-on-partner/{partnerId}

Operation: GetLoansOnPartner
Request: No request body
Response: Loan[]

Parameter	In	Type	Required	Description
`partnerId`	path	`string (uuid)`	Yes	partnerId

Request structure JSON

No request body

Response structure 200

[
  {
    "loanId": "00000000-0000-0000-0000-000000000000",
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "customerEmail": "string",
    "shortCode": "string",
    "statusName": "string",
    "createdDate": "2026-04-29T00:00:00Z",
    "lastUpdatedDate": "2026-04-29T00:00:00Z",
    "organisationId": "00000000-0000-0000-0000-000000000000",
    "offerId": "00000000-0000-0000-0000-000000000000",
    "agentId": "00000000-0000-0000-0000-000000000000",
    "secured": true,
    "tradingName": "string",
    "fullBusinessName": "string",
    "offerAccepted": true,
    "id": "00000000-0000-0000-0000-000000000000"
  }
]

Documented responses

Status	Schema	Description
200	`Loan[]`	OK
400	`ProblemDetails`	Bad Request

POST

Receive

/api/TestWebhook/receive

Operation: Receive
Request: WebhookPayload
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`body`	body	`WebhookPayload`	No	-

Request structure JSON

{
  "id": "string",
  "webhookEvent": "string",
  "data": "string",
  "creationTimeUtc": "2026-04-29T00:00:00Z"
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK

POST

GenerateSimulatedWebHook

/api/Webhook/generate-simulated-webhook

Operation: GenerateSimulatedWebHook
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`eventName`	query	`string`	No	-
`partnerId`	query	`string (uuid)`	No	-
`customerId`	query	`string (uuid)`	No	-

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK

GET

GetAllSubscriptions

/api/Webhook/get-all-subscriptions

Operation: GetAllSubscriptions
Request: No request body
Response: WebhookSubscriptionSummary[]

Request structure JSON

No request body

Response structure 200

[
  {
    "ownerId": "00000000-0000-0000-0000-000000000000",
    "ownerType": "string",
    "ownerName": "string",
    "ownerEmail": "string",
    "subscriptionId": "00000000-0000-0000-0000-000000000000",
    "webhookUri": "string",
    "secret": "string",
    "isActive": true,
    "webhooks": [
      "string"
    ]
  }
]

Documented responses

Status	Schema	Description
200	`WebhookSubscriptionSummary[]`	OK
403	`ProblemDetails`	Forbidden

GET

RegisteredWebHooks

/api/Webhook/get-registered-webhooks

Operation: RegisteredWebHooks
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`partnerId`	query	`string (uuid)`	No	-
`customerId`	query	`string (uuid)`	No	-

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK
400	`ProblemDetails`	Bad Request

GET

GetSubscription

/api/Webhook/get-subscription

Operation: GetSubscription
Request: No request body
Response: WebhookSubscription

Parameter	In	Type	Required	Description
`partnerId`	query	`string (uuid)`	No	-
`customerId`	query	`string (uuid)`	No	-

Request structure JSON

No request body

Response structure 200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "webhookUri": "string",
  "secret": "string",
  "isActive": true,
  "webhooks": [
    "string"
  ]
}

Documented responses

Status	Schema	Description
200	`WebhookSubscription`	OK

POST

Handler

/api/Webhook/handler

Operation: Handler
Request: WebhookPayload
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`body`	body	`WebhookPayload`	Yes	-

Request structure JSON

{
  "id": "string",
  "webhookEvent": "string",
  "data": "string",
  "creationTimeUtc": "2026-04-29T00:00:00Z"
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK

POST

Register partner or customer subscription.

/api/Webhook/register

Register a partner or customer subscription, then read back get-subscription to verify the saved configuration. See the Webhooks guide for setup and signature verification.

Operation: Register
Request: WebhookSubscription
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`partnerId`	query	`string (uuid)`	No	-
`customerId`	query	`string (uuid)`	No	-
`body`	body	`WebhookSubscription`	Yes	-

Request structure JSON

{
  "id": "00000000-0000-0000-0000-000000000000",
  "webhookUri": "string",
  "secret": "string",
  "isActive": true,
  "webhooks": [
    "string"
  ]
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK

POST

Unregister

/api/Webhook/unregister

Operation: Unregister
Request: WebhookSubscription
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`partnerId`	query	`string (uuid)`	No	-
`customerId`	query	`string (uuid)`	No	-
`body`	body	`WebhookSubscription`	Yes	-

Request structure JSON

{
  "id": "00000000-0000-0000-0000-000000000000",
  "webhookUri": "string",
  "secret": "string",
  "isActive": true,
  "webhooks": [
    "string"
  ]
}

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK

POST

UpdateAll

/api/Webhook/update-all

Operation: UpdateAll
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`partnerId`	query	`string (uuid)`	No	-
`customerId`	query	`string (uuid)`	No	-

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK

POST

Update partner or customer webhook uri.

/api/Webhook/update-webhook-uri

Operation: UpdateWebhookUri
Request: No request body
Response: Response body not specified in Swagger

Parameter	In	Type	Required	Description
`webhookUri`	query	`string`	Yes	-
`partnerId`	query	`string (uuid)`	No	-
`customerId`	query	`string (uuid)`	No	-

Request structure JSON

No request body

Response structure 200

No response body schema declared. Check the guide for this operation.

Documented responses

Status	Schema	Description
200	`Not specified`	OK

Plexe Public API documentation

No matching endpoints

Application

ApplicationApproval

ApplicationBulk

Authenication

Calculation

Communication

Customer

InvoiceCustomer

Loan

Lookup

Partner

TestWebhook

Webhook