Jump to Content
Guides
API Reference
API Reference
Guides
API Reference
Prequalification
Search
All
Pages
Start typing to search…
JUMP TO
Home
Introduction to APIs
Getting Started
Authentication
Environments
Prequalification
Prequalification
Generate a prequalified offer
post
Generate a prequalified offer for an existing customer (renewal)
post
Onboarding
Introduction to Onboarding
Onboarding API validation
Create an Application
Create a lead.
post
Update significant persons.
put
Submit bank statements.
post
Submit JSON bank statements.
post
Submit stage 1 of the onboarding process.
post
Enrich an Application
Submit a payment gateway.
post
Update organisation details.
put
Submit a KYC document for a significant person.
post
Submit account information.
post
Submit a management account document.
post
Submit payment data documents.
post
Submit JSON payment data.
post
Submit a comment.
post
Update the ThirdPartyCustomerId.
put
Submit a response to pending information.
post
Update lead owner.
put
Offers and Signing
Retrieve document signing information.
get
List loan offers.
get
Calculate loan offers.
post
Accept a loan offer.
post
Sign documents via 'instant signing'.
post
Sign a loan document via ‘instant signing’.
post
Retrieve unsigned loan document.
get
Retrieve the documents to sign for the lead.
get
Complete change of bank process.
post
Partner funding approval.
post
DELETE Details
Delete a KYC document for a significant person.
delete
Delete a bank statements.
delete
Delete a management account document.
delete
Delete a payment data document.
delete
Delete a payment gateway.
delete
Terminate a lead.
post
GET Details
Retrieve organisation details.
get
Retrieve management account documents.
get
List payment data documents.
get
List all documents.
get
List settlement details with account opening letter.
get
List all direct debit mandate documents.
get
List signed direct debit mandate documents.
get
Retrieve onboarding details.
get
List leads with filtering applied. Returns a max 500 of the most recent results.
get
Gets the list of merchants eligible for renewal.
get
List users who can be set as lead owners.
get
Third Party Loan API
Introduction to Loans API
Loans
List loans by lead id
get
(Fast Track only) Retrieve a loan by lead id
get
List loans by lending partner id
get
List all loans
get
List loans with filtering applied.
get
Retrieve a loan by loan id
get
Retrieve a document for a loan
get
List repayment information for a loan
get
PreApproval
Introduction to Preapproval API
PreApproval
Generate preapproved offers
post
WEBHOOKS
Introduction to Notifications
Creating a webhook
Events
SubscriptionEvents
An endpoint for getting all possible events to subscribe to.
get
WebhookSubscription
Creates a subscription to the provided list of events. Notifications will be sent to the provided WebhookURL
post
Returns a list of Webhook Subscriptions for the lending partner
get
Updates a subscription to the provided list of events
put
Deletes a subscription
delete
Verifying webhook requests
Repayment webhooks
INSTANT SETTLEMENT
Introduction to Instant Settlement
InstantSettlement
Create a transaction
post
Retrieve instant settlement details by instant settlement number
get
List transactions for an instant settlement
get
List instant settlements for a lending partner
get
List daily settlement activity entries for an instant settlement
get
Retrieve instant settlement details by merchant id
get
List instant settlements by locator id
get
InstantSettlementPreQual
Submit payment data
post
Retrieve prequalification decision by merchant id
get
Fast Track Onboarding
Introduction to Fast Track Onboarding
FastTrackLeads
Create a lead
post
Retrieve lead status
get
Update a lead
put
Submit a KYC document for a significant person
post
Submit a financing agreement document
post
Submit a KYC document
post
Submit an additional document
post
Approve funding
put
Prequalification
Before using these endpoints, we suggest you read
this guide
on prequalification.
