Skip to main content
Documentation Powered by Redocly

Business (1.0.0)

Download OpenAPI specification:Download

Capitalise: engineering@capitalise.com URL: https://capitalise.com

Overview

Business V1 provides a one-stop shop for small and medium businesses funding matching and intelligent scoring & insight services.

Migration from Marketplace V2 to Business V1

Please refer to this guide if you are looking to migrate from Marketplace V2 to Business V1.

Environments

Environment Base URL Description
Demo https://demo.capitalise.com/api/business/v1 Get started with test credentials and life-like data
Production https://capitalise.com/api/business/v1 Launch your app with live credentials

Authentication & Authorisation concepts

Business V1 only accepts platform access token which is generated from /platform/v1/auth/token generate platform access token.

You can restrict the platform access token to only access one specific tenant by providing Capitalise-tenant-id in the header.

Applications

Submit and track applications of the business

Submit an application for the business

Request Body schema: application/json
introducer-all-funding-products (object) or business-all-funding-products (object) or business-working-capital (object) or business-anonymous-working-capital (object)
One of
object non-empty

What is the business last reported annual amortisation?

code
required
string
Enum: "GBP" "ZAR"
value
required
number
assetExistingAgreement
boolean
Default: false

Is there an existing agreement for this asset? Optional to fill in when fundingAsset is True.

assetType
string
Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "STOCK" "TRANSPORTATION"

What kind of asset is it? Let us know the category of asset. Required only when fundingAsset is True.

averageCardSales
number
Enum: 15000 2500 35000 55000 7500 75000

What are the average monthly card sales? Include all payments through any terminal or commerce provider. Only required when cardPayments is True.

  • 2500 - up to £2,500
  • 7500 - up to £7,500
  • 15000 - up to £15,000
  • 35000 - up to £35,000
  • 55000 - up to £55,000
  • 75000 - up to £75,000
object non-empty

What is the business last reported annual bank interest?

code
required
string
Enum: "GBP" "ZAR"
value
required
number
businessOwnsAssets
boolean
Default: false

Does the business own assets or property?

businessPurposes
boolean
Default: null

Required when companyType = SOLE_TRADER. Our lenders will accept applications for business purposes only. Is this sole trader loan for business purposes?

cardPayments
required
boolean
Default: false

Does the business accept card payments? Credit/Debit card terminal, online payments or any other e-commerce payments.

clientEmail
required
string <email>

What is your e-mail to contact the applicant?

clientName
required
string

What is the full name of the applicant?

clientNumber
required
string^\+?[0-9\s]{11,30}$

What is the contact number of the applicant? E.g. +449328291829

companyName
required
string non-empty

What is the name of the company?

companyNumber
string non-empty

What is the registered company number? Required when companyType = LIMITED_COMPANY or LIMITED_LIABILITY_PARTNERSHIP.

companyType
required
string
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

What is your type of business?

object non-empty

What is the business last reported annual depreciation?

code
required
string
Enum: "GBP" "ZAR"
value
required
number
required
object

How much funding the business is searching for?

code
required
string
Enum: "GBP" "ZAR"
value
required
number multiple of 1 [ 25000 .. 1000000 ]
fundingAsset
required
boolean
Default: false

Is the funding for an asset? Let us know if funding will be used to purchase or refinance an asset.

fundingPeriod
required
number >= 0
Enum: 12 24 36 48 6 60

How long (in months) does the business need the funding?

  • 6 - 6 months or less
  • 12 - Up to 1 year
  • 24 - Up to 2 years
  • 36 - Up to 3 years
  • 48 - Up to 4 years
  • 60 - 5 years or more
fundingUrgency
string
Enum: "ASAP" "JUST_BROWSING" "ONE_MONTH" "ONE_WEEK" "REFINANCING"

How soon does the business need the funding?

governmentBacked
required
boolean
Default: false

Is the business only interested in a Recovery Loan?

governmentBackedLoansExist
required
boolean
Default: false

Does the business have any existing government backed loans? Let us know if the business has a CBILS, BBLS or similar product.

homeOwnership
boolean
Default: false

Is any of the directors UK homeowner?

incorporationDate
required
string <date>

When did the business start trading?

inviteClient
boolean
Default: false

Automatically invite the client to the view and track application at Capitalise.com? Highly recommend to set it as true. We will send the client an email with a link to the fudning search once it is submitted to us (upon 200 response of request to POST /apply).

legalRequirements
required
boolean
Default: true

Allow Capitalise to contact the client to collect consent required by lenders and ensure your commission disclosure requirements are met.

object

What is the business last reported annual net profit?

code
required
string
Enum: "GBP" "ZAR"
value
required
number
personalGuarantee
boolean
Default: false

Director(s) of the business can offer a limited personal guarantee... Most lenders will require directors to offer this.

purchaseOrders
required
boolean
Default: false

Does the business receive purchase orders? Or if your company imports good from outside the UK.

raiseInvoices
required
boolean
Default: false

Does The business raise invoices to clients? Invoices should have payment terms of 14 days or more.

required
object non-empty

What is the business last reported annual revenue?

code
required
string
Enum: "GBP" "ZAR"
value
required
number
sector
required
string non-empty
Enum: "AGRICULTURE" "AUTOMOTIVE" "BUSINESS_SERVICES" "CHARITIES" "CONSTRUCTION" "COURIER" "DISTRIBUTION" "EDUCATION" "FINANCIAL_SERVICES" "HAULAGE" "HEALTHCARE_CARE" "HOTELS_HOUSE" "IMPORT_EXPORT" "IT_RELATED" "MANUFACTURING" "MEDIA_AND_ENTERTAINMENT" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"

What sector is the business in?

object

What are the business current trade debtors?

code
required
string
Enum: "GBP" "ZAR"
value
required
number
tradingAddress
string non-empty
Example: "Number, Street, Postcode"

What is the business trading address? Format :Street, no, postcode

useOfFunds
required
string
Enum: "ACQUIRING_BUSINESS" "BUSINESS_EXPANSION" "CASH_FLOW" "EQUIPMENT_ASSET_FINANCE" "IMPORT_EXPORT" "PURCHASING_PROPERTY" "PURCHASING_STOCK" "REFINANCING_DEBT" "STARTING_BUSINESS" "TAX_BILL_DUE"
Example: "CASH_FLOW"

What will the funds be used for?

type
required
string
Enum: "business-all-funding-products" "business-anonymous-working-capital" "business-working-capital" "introducer-all-funding-products" "introducer-commercial-property" "introducer-credit-improvement" "introducer-debt-recovery" "introducer-grants" "introducer-rd-tax-claim" "introducer-recovery-loan-scheme" "introducer-working-capital"

Responses

Response Schema: application/json
id
string

Application ID

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Generate the URL for user to continue application at Capitalise.com

path Parameters
applicationId
required
string

Responses

Response Schema: application/json
continueUrl
string

The questionnaire URL for the user to continue the application in Capitalise

Response samples

Content type
application/json
{
}

Profile

/profile provides the profile of company, including high-level credit score grade and legal notics information.

Credit score grade mapping:

Grade title description
A Minimum risk This companty is considered as minimum risk. There is a low probability of the company going into defaul in the next 12 month. Offering credit terms to the recommended credit limit is advised. Highly likely to access finance at favourable rates
B Low risk This companty is considered as low risk. There is a low probability of the company going into defaul in the next 12 month. Offering credit terms to the recommended credit limit is advised. Highly likely to access finance at favourable rates
C Below average risk The company is consisdered as below average risk. There is a moderate probability of the company going into default in the next 12 months. Offering credit terms above the recommended credit limit is advised against. Likely to access high value finance but a guarantee may be required
D Above average risk The company is consisdered as above average risk. There is a moderate probability of the company going into default in the next 12 months. Offering credit terms above the recommended credit limit is advised against. Likely to access high value finance but a guarantee may be required
E High risk There company is considered as high risk and has a high probability of this company going into default in the next 12 months. Offering credit terms above the recommended credit limit is advised against. Challenging to access finance and a personal guaranteed might be required.
F Maximum risk There company is considered as maximum risk and has a high probability of this company going into default in the next 12 months. Offering credit terms above the recommended credit limit is advised against. Challenging to access finance and a personal guaranteed might be required.
G Dissolved There company is dissolved.

Set up profile details

header Parameters
Authorization
required
string <JWT Token>

The token generated from the API key

Capitalise-tenant-id
required
string <uuid>

The tenant id

Request Body schema: application/json
required
object
registrationNumber
required
string

The Companies House number

Responses

Response Schema: application/json
required
object
object
code
string
Enum: "GBP" "ZAR"

The currency of the credit limit value

value
number

The value of the credit limit

object
object
last12MonthsCount
number

The count of County Court Judgements (CCJs) and other negative events registered against the company

object
code
string

The currency of the value

value
number

The monetary value across all registries

object
last12MonthsCount
number

The count of County Court Judgements (CCJs) and other negative events registered against all directors of the company

object
code
string

The currency of the value

value
number

The monetary value across all registries

name
string

The name of the company

registrationNumber
string

The registration number of the company

object
changedAt
string <date-time>

The date that the credit grade has changed into current grade

grade
string non-empty
Enum: "A" "B" "C" "D" "E" "F" "G"

The credit score grade of the company

industryAverageGrade
string
Enum: "A" "B" "C" "D" "E" "F" "G"

The average of the score of the industry that the company is in

lastAssessedAt
string <date-time>

The date that current credit grade is assessed

object
grade
string
Enum: "A" "B" "C" "D" "E" "F" "G"

The credit score grade before current grade

sector
string
Enum: "AGRICULTURE" "AUTOMOTIVE" "BUSINESS_SERVICES" "CHARITIES" "CONSTRUCTION" "COURIER" "DISTRIBUTION" "EDUCATION" "FINANCIAL_SERVICES" "HAULAGE" "HEALTHCARE_CARE" "HOTELS_HOUSE" "IMPORT_EXPORT" "IT_RELATED" "MANUFACTURING" "MEDIA_AND_ENTERTAINMENT" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"

The sector of the company

type
string
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

The type of the company

createdAt
required
string

Profile created date time

id
required
string

The profile ID

updatedAt
required
string

Profile updated date time

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Credit Report

Track credit report of the business

Retrieve credit report

Upcoming feature - please contact support@capitalise.com if you want to learn more

Retrieve the credit report in PDF format

Upcoming feature - please contact support@capitalise.com if you want to learn more