API reference

Plexe Public API documentation

Browse the live endpoint catalogue generated from the API Swagger metadata, with route groups, parameters, request models, and response examples in a ReadMe-style layout.

74 endpoints 12 groups 65 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`	Yes	-
`bankName`	query	`string`	No	-
`body`	body	`BankingDataRequest`	No	-

Request JSON

{
  "bankAccounts": [
    {
      "bank": "string",
      "availableBalance": "string",
      "currentBalance": "string",
      "accountNumber": "string",
      "routing": "string",
      "accountType": "string",
      "transactions": [
        "value"
      ],
      "accountName": "string"
    }
  ]
}

Response 200

true

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`	Yes	applicationId
`force`	query	`boolean`	No	force

Request JSON

{ }

Response 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
}

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`	Yes	applicationId

Request JSON

{ }

Response 200

"string"

POST

Create Application

/api/Application/create-application

Operation: CreateApplication
Request: ApplicationRequest
Response: string

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

Request JSON

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

Response 200

"string"

POST

Create Application

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

Operation: CreateApplicationAndApplicant
Request: ApplicationAndApplicantRequest
Response: string

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

Request 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",
  "businessZip": "string",
  "businessName": "string",
  "extraInformation": "string"
}

Response 200

"string"

POST

Create Customer

/api/Application/create-customer

Operation: CreateCustomer
Request: UserRequest
Response: UserResponse

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

Request JSON

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

Response 200

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

POST

Create new customer and application

/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 JSON

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

Response 200

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

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 JSON

{
  "applicant": {
    "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",
    "extraInformation": "string"
  },
  "customer": {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "password": "string",
    "mobileNumber": "string"
  }
}

Response 200

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

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`	Yes	applicationId

Request JSON

{ }

Response 200

{
  "secondaryApplicantRequested": true,
  "primaryApplicantAdded": true,
  "secondaryApplicantAdded": true,
  "loanType": "string",
  "partnerId": "00000000-0000-0000-0000-000000000000",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "businessName": "string",
  "shortCode": "string"
}

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`	Yes	customerId

Request JSON

{ }

Response 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "shortCode": "string"
  }
]

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`	Yes	partnerId
`skip`	query	`integer`	No	skip
`take`	query	`integer`	No	take

Request JSON

{ }

Response 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "shortCode": "string"
  }
]

GET

For Process Application

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

Operation: ProcessApplication
Request: No request body
Response: string

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	applicationId

Request JSON

{ }

Response 200

"string"

GET

UpdateApplicationData

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

Operation: UpdateApplicationData
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	-
`name`	query	`string`	Yes	-
`zipcode`	query	`string`	Yes	-
`startDate`	query	`string`	Yes	-

Request JSON

{ }

Response 200

true

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`	Yes	-
`name`	query	`string`	No	-
`zipCode`	query	`string`	No	-

Request JSON

{ }

Response 200

true

GET

UpdateApplicationName

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

Operation: UpdateApplicationName
Request: No request body
Response: boolean

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

Request JSON

{ }

Response 200

true

GET

UpdateCustomerData

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

Operation: UpdateCustomerData
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	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`	Yes	-

Request JSON

{ }

Response 200

true

POST

Add company details

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

Operation: AddCompanyDetails
Request: CompanyDataRequest
Response: Success

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

Request JSON

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

Response 200

{
  "status": "Success"
}

POST

Add primary applicant details

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

Operation: AddPrimaryApplicantDetails
Request: PrimaryApplicantRequest
Response: Success

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

Request 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": "string"
}

Response 200

{
  "status": "Success"
}

POST

Add secondary applicant details

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

Operation: AddSecondaryApplicantDetails
Request: SecondaryApplicantRequest
Response: Success

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

Request 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": "string"
}

Response 200

{
  "status": "Success"
}

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`	Yes	-

Request JSON

{ }

Response 200

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

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`	Yes	-

Request JSON

{ }

Response 200

[
  {
    "isConnected": true,
    "archived": true,
    "enabled": true,
    "slug": "string",
    "accountType": "string",
    "accountHolder": "string",
    "available": "string",
    "balance": "string"
  }
]

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`	Yes	Application Id

Request JSON

{ }

Response 200

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

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`	Yes	Application Id

Request JSON

{ }

Response 200

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

GET

Get primary bank account

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

Operation: GetPrimaryBankAccount
Request: No request body
Response: Success

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

Request JSON

{ }

Response 200

{
  "status": "Success"
}

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`	Yes	Application Id

Request JSON

{ }

Response 200

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

POST

Set primary bank account

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

Operation: SetPrimaryBankAccount
Request: No request body
Response: Success

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

Request JSON

{ }

Response 200

{
  "status": "Success"
}

POST

Sign contract by applicant

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

Operation: SignContract
Request: SignaturesRequest
Response: Success

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

Request JSON

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

Response 200

{
  "status": "Success"
}

POST

SubmitDocument

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

Operation: SubmitDocument
Request: string
Response: Success

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	-
`fileType`	query	`string`	Yes	-
`fileName`	query	`string`	Yes	-
`body`	body	`string`	Yes	-

Request JSON

"string"

Response 200

{
  "status": "Success"
}

POST

SubmitRequiredDocument

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

Operation: SubmitRequiredDocument
Request: string
Response: Success

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

Request JSON

"string"

Response 200

{
  "status": "Success"
}

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 JSON

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

Response 200

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

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 JSON

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

Response 200

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

GET

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

/api/Authenication/login

Operation: Login
Request: No request body
Response: FullApplicationUser

Parameter	In	Type	Required	Description
`username`	query	`string`	Yes	Your Plexe username
`password`	query	`string`	Yes	Your Plexe password

Request JSON

{ }

Response 200

{
  "firstName": "string",
  "lastName": "string",
  "id": "string",
  "email": "string",
  "username": "string",
  "userType": "string",
  "token": "string",
  "expiresUTC": "2026-04-29T00:00:00Z"
}

POST

If the Bearer token expires, then call this to refresh it and return the new token

/api/Authenication/refresh-token

Operation: RefreshToken
Request: No request body
Response: string

Request JSON

{ }

Response 200

"string"

POST

Application Invoice Calculation

/api/Calculation/application-invoice-calculation

Operation: CalculateInvoice
Request: CalculationRequest
Response: CalculationResponse

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

Request JSON

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

Response 200

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

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`	Yes	applicationId
`body`	body	`CalculationRequest`	No	calculationRequest

Request JSON

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

Response 200

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

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`	Yes	applicationId
`body`	body	`SliderRequest`	No	applicationId

Request JSON

{
  "amount": 123.45
}

Response 200

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

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`	Yes	applicationId
`skip`	query	`integer`	No	skip
`take`	query	`integer`	No	take

Request JSON

{ }

Response 200

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

POST

For Post Message

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

Operation: PostMessage
Request: CommunicationRequest
Response: Success

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	applicationId
`body`	body	`CommunicationRequest`	No	communicationRequest

Request JSON

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

Response 200

{
  "status": "Success"
}

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`	Yes	loanId
`skip`	query	`integer`	No	skip
`take`	query	`integer`	No	take

Request JSON

{ }

Response 200

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

POST

Enable Invoice

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

Operation: RequestEnableInvoiceCustomers
Request: No request body
Response: Success

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

Request JSON

{ }

Response 200

{
  "status": "Success"
}

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`	Yes	loanId
`body`	body	`WithdrawInvoiceRequestData`	No	request

Request JSON

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

Response 200

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

POST

Confirm Withdrawal line of credit by loan Id

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

Operation: ConfirmWithdrawalLineOfCredit
Request: WithdrawLineRequest
Response: GuidApiResponse

Parameter	In	Type	Required	Description
`loanId`	path	`string`	Yes	loanId
`body`	body	`WithdrawLineRequest`	No	request

Request JSON

{
  "advanceRate": 123.45,
  "otp": "string",
  "dateUTC": "2026-04-29T00:00:00Z",
  "amount": 123.45,
  "percentOfIncome": 123.45,
  "terms": 123,
  "fixedRepaymentCalculation": true
}

Response 200

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

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`	Yes	loanId

Request JSON

{ }

Response 200

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

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`	Yes	customerId

Request JSON

{ }

Response 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"
  }
]

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`	Yes	-

Request JSON

{ }

Response 200

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

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`	Yes	-

Request JSON

{ }

Response 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"
}

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`	Yes	loanId

Request JSON

{ }

Response 200

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

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`	Yes	-

Request JSON

{ }

Response 200

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

GET

GetTransactionsPaged

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

Operation: GetTransactionsPaged
Request: No request body
Response: PagedListTransactionResponse

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

Request JSON

{ }

Response 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
}

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`	Yes	loanId
`skip`	query	`integer`	No	skip
`take`	query	`integer`	No	take

Request JSON

{ }

Response 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"
    }
  }
]

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`	Yes	loanId
`skip`	query	`integer`	No	skip
`take`	query	`integer`	No	take
`descending`	query	`boolean`	No	by date

Request JSON

{ }

Response 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"
    }
  ],
  "totalCount": 123
}

GET

IsLoanClosed

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

Operation: IsLoanClosed
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`loanId`	path	`string`	Yes	-

Request JSON

{ }

Response 200

true

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`	Yes	-

Request JSON

{ }

Response 200

true

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`	Yes	loanId
`body`	body	`InvoiceWithdrawalRequest`	No	request

Request JSON

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

Response 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
}

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`	Yes	loanId
`body`	body	`LineOfCreditWithdrawalRequest`	No	request

Request JSON

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

Response 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
}

POST

Resend Withdrawal Otp

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

Operation: ResendWithdrawalOtp
Request: No request body
Response: string

Parameter	In	Type	Required	Description
`loanId`	path	`string`	Yes	-

Request JSON

{ }

Response 200

"string"

GET

For Get Industries

/api/Lookup/get-industries

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

Request JSON

{ }

Response 200

[
  {
    "name": "string"
  }
]

GET

Get Applicaction 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`	Yes	-

Request JSON

{ }

Response 200

[
  {
    "secondaryApplicantRequested": true,
    "primaryApplicantAdded": true,
    "secondaryApplicantAdded": true,
    "loanType": "string",
    "partnerId": "00000000-0000-0000-0000-000000000000",
    "customerId": "00000000-0000-0000-0000-000000000000",
    "businessName": "string",
    "shortCode": "string"
  }
]

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`	Yes	partnerId

Request JSON

{ }

Response 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"
  }
]

GET

AcceptOffer

/api/Testing/accept-offer/{applicationId}

Operation: AcceptOffer
Request: No request body
Response: string

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	-

Request JSON

{ }

Response 200

"string"

GET

CloseLoanOnApplication

/api/Testing/close-loan-on-application-id/{applicationId}

Operation: CloseLoanOnApplication
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	-

Request JSON

{ }

Response 200

true

GET

CloseLoanOnLoan

/api/Testing/close-loan-on-loan-id/{loanId}

Operation: CloseLoanOnLoan
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`loanId`	path	`string`	Yes	-

Request JSON

{ }

Response 200

true

GET

CreateLoan

/api/Testing/create-loan/{applicationId}

Operation: CreateLoan
Request: No request body
Response: string

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	-

Request JSON

{ }

Response 200

"string"

GET

EnableLoanOnApplication

/api/Testing/enable-loan-on-application-id/{applicationId}

Operation: EnableLoanOnApplication
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	-
`status`	query	`boolean`	No	-

Request JSON

{ }

Response 200

true

GET

EnableLoanOnLoan

/api/Testing/enable-loan-on-loan-id/{loanId}

Operation: EnableLoanOnLoan
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`loanId`	path	`string`	Yes	-
`status`	query	`boolean`	No	-

Request JSON

{ }

Response 200

true

POST

SimulateTestMessage

/api/Testing/simulate-test-message/{applicationId}

Operation: SimulateTestMessage
Request: No request body
Response: string

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	-
`details`	query	`string`	No	-

Request JSON

{ }

Response 200

"string"

GET

Update application status

/api/Testing/update-application-status/{applicationId}

Operation: UpdateApplicationStatus
Request: No request body
Response: boolean

Parameter	In	Type	Required	Description
`applicationId`	path	`string`	Yes	applicationId
`status`	query	`string`	No	status

Request JSON

{ }

Response 200

true

POST

GenerateSimulatedWebHook

/api/Webhook/generate-simulated-webhook

Operation: GenerateSimulatedWebHook
Request: No request body
Response: Success

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

Request JSON

{ }

Response 200

{
  "status": "Success"
}

GET

RegisteredWebHooks

/api/Webhook/get-registered-webhooks

Operation: RegisteredWebHooks
Request: No request body
Response: Success

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

Request JSON

{ }

Response 200

{
  "status": "Success"
}

POST

Handler

/api/Webhook/handler

Operation: Handler
Request: WebhookPayload
Response: Success

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

Request JSON

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

Response 200

{
  "status": "Success"
}

POST

Register partner or customer subscription

/api/Webhook/register

No frontend yet to call this endpoint. Subscription might have some details to add.

Operation: Register
Request: WebhookSubscription
Response: Success

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

Request JSON

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

Response 200

{
  "status": "Success"
}

POST

Unregister

/api/Webhook/unregister

Operation: Unregister
Request: WebhookSubscription
Response: Success

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

Request JSON

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

Response 200

{
  "status": "Success"
}

POST

UpdateAll

/api/Webhook/update-all

Operation: UpdateAll
Request: No request body
Response: Success

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

Request JSON

{ }

Response 200

{
  "status": "Success"
}

POST

Update partner or customer webhook uri

/api/Webhook/update-webhook-uri

Operation: UpdateWebhookUri
Request: No request body
Response: Success

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

Request JSON

{ }

Response 200

{
  "status": "Success"
}