Skip to main content
Documentation Powered by Redocly

Marketplace (1.0.0)

Download OpenAPI specification:Download

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

Overview

The Capitalise Marketplace API allows developers access to Capitalise matching services and intelligent scoring & insight services.

With this API you can:

  • Integrate a questionnaire flow directly into your platform
  • Use your data to deliver targeted product matching
  • Enhance your application with business scoring intelligence

Marketplace V2 can be found here.

Auth

Get marketplace access token

This endpoint allows you to get a marketplace token from a marketplace api key.

Authorizations:
bearerAuth
query Parameters
api_key
required
string
Example: api_key=161c04f04289f442f8b9b91fdd39c554597639876e9bda4d16bed31a787b5c5d

Capitalise API key.

Responses

Response Schema: application/json
jwt
string

Marketplace API OAuth2 Token (JWT)

refreshToken
string

Marketplace API OAuth2 Refresh Token

Response samples

Content type
application/json
{
}

Refresh marketplace access token.

This endpoint allows you to get a refresh access token from a refresh token.

Authorizations:
bearerAuth
Request Body schema: application/json
refreshToken
required
string

Responses

Response Schema: application/json
jwt
string

Marketplace API OAuth2 Token (JWT)

refreshToken
string

Marketplace API OAuth2 Refresh Token

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Cases

Create a non-funding case.

This endpoint allows you to apply a profile into a non-funding case (ex: Recovery, Grants, Credit Improvement).

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

Responses

Response Schema: application/json
businessId
number
caseState
string
caseStateName
string
object (CaseDetailsDto)

(tsType: CaseDetailsDto, schemaOptions: { exclude: undefined })

amount
object
description
string
title
string
followers
Array of strings
id
string
object (CaseIntegrationDto)

(tsType: CaseIntegrationDto, schemaOptions: { exclude: undefined })

generatedAt
string <date-time>
name
string
object (CaseLatestActvityDto)

(tsType: CaseLatestActvityDto, schemaOptions: { exclude: undefined })

createdAt
string <date-time>
id
string
title
string
object (CaseManagerDto)

(tsType: CaseManagerDto, schemaOptions: { exclude: undefined })

id
number
offersAwaitingReview
boolean
object (CaseOwnerDto)

(tsType: CaseOwnerDto, schemaOptions: { exclude: undefined })

email
string
id
number
name
string
team
number
private
boolean
product
string
productName
string
productNames
Array of strings
products
Array of strings
profile
string
state
string
stateName
string
stateType
string
stateUpdatedAt
string <date-time>
type
string

Response samples

Content type
application/json
{
}

Companies

Lookup companies by name or registration number

Support for searching for a company by its name or company registration number. By default, this search returns 10 results at a time, but you can override this by passing a custom limit.

Authorizations:
bearerAuth
path Parameters
searchTerm
required
string
Example: Capitalise

Registration reference or name

query Parameters
countryCode
string
Example: countryCode=GB

Country code.

limit
number
Example: limit=10

Limit results.

Responses

Response Schema: application/json
Array
name
string
number
string

Response samples

Content type
application/json
[
]

Get company data by registration number.

Get companies data by registration number.

Authorizations:
bearerAuth
path Parameters
registrationNumber
required
string
Example: 09256446

Company registration number

query Parameters
countryCode
string
Example: countryCode=GB

Country code.

Responses

Response Schema: application/json
non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string

Response samples

Content type
application/json
{
}

Funding

Send the preferred lenders to Capitalise

Preferred lender and matches will be submitted to Capitalise and a Funding Specialist will pick up and work with the business to review the information. No information will be sent to lender nor will credit check be perform with this endpoint.

Allow only the first 4 matches identified to be added to the application, any additional matches will throw a BAD REQUEST error.

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

Request Body schema: application/json
Array ([ 1 .. 4 ] items)
lenderId
number
products
Array of strings
Items Enum: "ASSET_BACKED_FINANCE" "COMMERCIAL_PROPERTY" "E_COMMERCE_FUNDING" "FIXED_LOAN_TERMS" "INVOICE_FINANCE" "MERCHANT_CASH_ADVANCE" "TERM_LOAN" "TRADE_FINANCE"

Responses

Response Schema: application/json
amount
number
id
number
Array of objects (FundingMatchDto)
Array
applicationTypes
Array of strings
Items Enum: "INSTANT_APPLICATION" "INSTANT_OFFER"
object (FeesDto)

(tsType: FeesDto, schemaOptions: { exclude: undefined })

arrangementFees
number
earlyRepaymentFees
number
exitFees
number
hasArrangementFees
object
hasEarlyRepaymentFees
object
hasExitFees
object
governmentBacked
boolean
id
number
object (LenderDto)

(tsType: LenderDto, schemaOptions: { exclude: undefined })

average
string
countryCode
string
Enum: "GB" "ZA"
description
string
documents
Array of strings
entityType
string
Enum: "BUSINESS" "INTRODUCER" "LENDER"
features
Array of strings
governmentBacked
boolean
icon
string
id
number
logo
string
name
string
object (NoteDto)

(tsType: NoteDto, schemaOptions: { exclude: undefined })

updatedAt
string <date-time>
updatedBy
string
value
string
object (PeriodDto)

(tsType: PeriodDto, schemaOptions: { exclude: undefined })

maximum
number
minimum
number
responseTime
number
type
string
property name*
additional property
any
object (LikelihoodDto)

(tsType: LikelihoodDto, schemaOptions: { exclude: undefined })

description
string
value
number
product
string
Enum: "ASSET_BACKED_FINANCE" "COMMERCIAL_PROPERTY" "E_COMMERCE_FUNDING" "FIXED_LOAN_TERMS" "INVOICE_FINANCE" "MERCHANT_CASH_ADVANCE" "TERM_LOAN" "TRADE_FINANCE"
object (RevenueDto)

(tsType: RevenueDto, schemaOptions: { exclude: undefined })

maximum
number
minimum
number

Request samples

Content type
application/json
[
]

Response samples

Content type
application/json
{
}

Get the amount of matched lenders.

Get the total amount of matched lenders for the given profile.

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

query Parameters
productTypes
Array of any
Example: productTypes=TERM_LOAN,COMMERCIAL_PROPERTY

Responses

Response Schema: application/json
any

Response samples

Content type
application/json
4

Get funding matches.

Retrieves all the available funding matches currently matched with the given profile.

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

query Parameters
productTypes
Array of any
Example: productTypes=TERM_LOAN,COMMERCIAL_PROPERTY

Responses

Response Schema: application/json
amount
number
id
number
Array of objects (FundingMatchDto)
Array
applicationTypes
Array of strings
Items Enum: "INSTANT_APPLICATION" "INSTANT_OFFER"
object (FeesDto)

(tsType: FeesDto, schemaOptions: { exclude: undefined })

arrangementFees
number
earlyRepaymentFees
number
exitFees
number
hasArrangementFees
object
hasEarlyRepaymentFees
object
hasExitFees
object
governmentBacked
boolean
id
number
object (LenderDto)

(tsType: LenderDto, schemaOptions: { exclude: undefined })

average
string
countryCode
string
Enum: "GB" "ZA"
description
string
documents
Array of strings
entityType
string
Enum: "BUSINESS" "INTRODUCER" "LENDER"
features
Array of strings
governmentBacked
boolean
icon
string
id
number
logo
string
name
string
object (NoteDto)

(tsType: NoteDto, schemaOptions: { exclude: undefined })

updatedAt
string <date-time>
updatedBy
string
value
string
object (PeriodDto)

(tsType: PeriodDto, schemaOptions: { exclude: undefined })

maximum
number
minimum
number
responseTime
number
type
string
property name*
additional property
any
object (LikelihoodDto)

(tsType: LikelihoodDto, schemaOptions: { exclude: undefined })

description
string
value
number
product
string
Enum: "ASSET_BACKED_FINANCE" "COMMERCIAL_PROPERTY" "E_COMMERCE_FUNDING" "FIXED_LOAN_TERMS" "INVOICE_FINANCE" "MERCHANT_CASH_ADVANCE" "TERM_LOAN" "TRADE_FINANCE"
object (RevenueDto)

(tsType: RevenueDto, schemaOptions: { exclude: undefined })

maximum
number
minimum
number

Response samples

Content type
application/json
{
}

Helpers

Returns a URL to travel to a particular part of business logic on our application.

Returns a URL to travel to a particular part of business logic on our application.

Redirect query parameter controls if redirect happens automatically or not.

Authorizations:
bearerAuth
path Parameters
type
required
string
Value: "funding-search"

Type of url.

uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

query Parameters
redirect
boolean
Default: false

Redirect option

Responses

Response Schema: application/json
url
string

Response samples

Content type
application/json
{}

Profiles

/profiles/anonymous

This endpoint generates a new blank anonymous profile which can be used to store data submitted through questionnaires.

Authorizations:
bearerAuth
Request Body schema: application/json
countryCode
string
Enum: "GB" "ZA"

Responses

Response Schema: application/json
Array of objects (AssetDataDto)
Array
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
existingAgreement
boolean
name
string (Make/model/URL)
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
offeredAsGuarantee
boolean
type
string (Asset type)
Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "STOCK" "TRANSPORTATION"
Array of objects (AssetSecurityDataDto)
Array
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

owner
string (Asset owner)
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
type
string (Asset type)
Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (CompanyInformationDto) non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string
createdAt
string <date-time>
object (EligibilityRequestResponseDto)

(tsType: EligibilityRequestResponseDto, schemaOptions: { exclude: undefined })

appliedProducts
Array of strings
object (AssetFinanceDto)

(tsType: AssetFinanceDto, schemaOptions: { exclude: undefined })

ownsAssets
boolean
object (CommercialPropertyDto)

(tsType: CommercialPropertyDto, schemaOptions: { exclude: undefined })

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
portfolioSize
string
productPropertyType
string
refinancing
boolean
repaymentMethod
string
object (InnovationRequirementsDto) non-empty

(tsType: InnovationRequirementsDto, schemaOptions: { exclude: undefined })

object (GrantsDto) non-empty

(tsType: GrantsDto, schemaOptions: { exclude: undefined })

previousGrantApplication
boolean
uniqueIp
boolean
object (RdTaxClaimDto) non-empty

(tsType: RdTaxClaimDto, schemaOptions: { exclude: undefined })

hasTaxRelief
boolean
isInnovating
boolean
tradingDifficulty
boolean
object (InvoiceFinanceDto)

(tsType: InvoiceFinanceDto, schemaOptions: { exclude: undefined })

customerType
number
raisesInvoices
boolean
object (MerchantCashDto)

(tsType: MerchantCashDto, schemaOptions: { exclude: undefined })

acceptsCommercePayments
boolean
object (RecoveryDto) non-empty

(tsType: RecoveryDto, schemaOptions: { exclude: undefined })

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (CompanyInformationDto) non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string
requestedProducts
Array of strings
object (EligibilityRequestSharedDataDto)

(tsType: EligibilityRequestSharedDataDto, schemaOptions: { exclude: undefined })

backgroundPurpose
required
string (Background and purpose)

What is the business background and the purpose of funds?

declaredForBusinessPurposes
boolean
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
fundingPeriod
number
fundingUrgency
string
previousLoanApplication
boolean
previousLoanDeclined
boolean
tradingImpacted
boolean
useOfFunds
string
sourceQuestionnaireId
string
object (TermLoanDto)

(tsType: TermLoanDto, schemaOptions: { exclude: undefined })

hasTermLoan
boolean
preferredCreditFacility
Array of strings
object (TradeFinanceDto)

(tsType: TradeFinanceDto, schemaOptions: { exclude: undefined })

hasPurchaseOrders
boolean
object (FinancialsDto) non-empty
Example: {"revenue":{"code":"GBP","value":100000}}
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (DebtorDto)
Array
contactId
string
contactNumber
string
debtorDays
number
emailAddress
string
firstName
string
id
required
string
lastName
string
name
string
outstandingAmount
number
outstandingAmountMonthlyAverage
number
outstandingInvoicesCount
number
revenue
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
primaryBank
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (TradingHistoryDto)
Array
debtorsInvoicesDue
number
debtorsOutstanding
number (Trade debtors)
dividends
number
fixedAssets
number (Fixed assets)
netAssets
number (Net assets)
profitNet
required
number (Net profit/loss before tax)
revenue
required
number (Turnover)
year
number
yearEnd
required
number (End of trading year)
object (ProfileCoreApiLegacyDto)

(tsType: ProfileCoreApiLegacyDto, schemaOptions: { exclude: undefined })

entityBusinessId
number
fundingSearchId
number
Array of objects (MerchantCashAdvanceDataDto)
Array
averageMonthlyTransactions
number
Array of objects (PersonDto)
Array
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

dateOfBirth
string <date-time>
name
string
title
string
type
string
Array of objects (PropertyDataDto)
Array
additionalDetails
string (Additional Details)
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

classification
string (Classification)
Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
location
string (Location)
Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
setting
string (Setting)
Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"
type
string (Type)
Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
updatedAt
string <date-time>
uuid
string

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Generate a new blank profile

This endpoint generates a new blank profile which can be used to store data submitted through questionnaires (or directly) in order to be applied into a product search.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array of objects (AssetDataDto)
Array
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
existingAgreement
boolean
name
string (Make/model/URL)
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
offeredAsGuarantee
boolean
type
string (Asset type)
Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "STOCK" "TRANSPORTATION"
Array of objects (AssetSecurityDataDto)
Array
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

owner
string (Asset owner)
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
type
string (Asset type)
Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (CompanyInformationDto) non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string
createdAt
string <date-time>
object (EligibilityRequestResponseDto)

(tsType: EligibilityRequestResponseDto, schemaOptions: { exclude: undefined })

appliedProducts
Array of strings
object (AssetFinanceDto)

(tsType: AssetFinanceDto, schemaOptions: { exclude: undefined })

ownsAssets
boolean
object (CommercialPropertyDto)

(tsType: CommercialPropertyDto, schemaOptions: { exclude: undefined })

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
portfolioSize
string
productPropertyType
string
refinancing
boolean
repaymentMethod
string
object (InnovationRequirementsDto) non-empty

(tsType: InnovationRequirementsDto, schemaOptions: { exclude: undefined })

object (GrantsDto) non-empty

(tsType: GrantsDto, schemaOptions: { exclude: undefined })

previousGrantApplication
boolean
uniqueIp
boolean
object (RdTaxClaimDto) non-empty

(tsType: RdTaxClaimDto, schemaOptions: { exclude: undefined })

hasTaxRelief
boolean
isInnovating
boolean
tradingDifficulty
boolean
object (InvoiceFinanceDto)

(tsType: InvoiceFinanceDto, schemaOptions: { exclude: undefined })

customerType
number
raisesInvoices
boolean
object (MerchantCashDto)

(tsType: MerchantCashDto, schemaOptions: { exclude: undefined })

acceptsCommercePayments
boolean
object (RecoveryDto) non-empty

(tsType: RecoveryDto, schemaOptions: { exclude: undefined })

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (CompanyInformationDto) non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string
requestedProducts
Array of strings
object (EligibilityRequestSharedDataDto)

(tsType: EligibilityRequestSharedDataDto, schemaOptions: { exclude: undefined })

backgroundPurpose
required
string (Background and purpose)

What is the business background and the purpose of funds?

declaredForBusinessPurposes
boolean
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
fundingPeriod
number
fundingUrgency
string
previousLoanApplication
boolean
previousLoanDeclined
boolean
tradingImpacted
boolean
useOfFunds
string
sourceQuestionnaireId
string
object (TermLoanDto)

(tsType: TermLoanDto, schemaOptions: { exclude: undefined })

hasTermLoan
boolean
preferredCreditFacility
Array of strings
object (TradeFinanceDto)

(tsType: TradeFinanceDto, schemaOptions: { exclude: undefined })

hasPurchaseOrders
boolean
object (FinancialsDto) non-empty
Example: {"revenue":{"code":"GBP","value":100000}}
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (DebtorDto)
Array
contactId
string
contactNumber
string
debtorDays
number
emailAddress
string
firstName
string
id
required
string
lastName
string
name
string
outstandingAmount
number
outstandingAmountMonthlyAverage
number
outstandingInvoicesCount
number
revenue
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
primaryBank
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (TradingHistoryDto)
Array
debtorsInvoicesDue
number
debtorsOutstanding
number (Trade debtors)
dividends
number
fixedAssets
number (Fixed assets)
netAssets
number (Net assets)
profitNet
required
number (Net profit/loss before tax)
revenue
required
number (Turnover)
year
number
yearEnd
required
number (End of trading year)
object (ProfileCoreApiLegacyDto)

(tsType: ProfileCoreApiLegacyDto, schemaOptions: { exclude: undefined })

entityBusinessId
number
fundingSearchId
number
Array of objects (MerchantCashAdvanceDataDto)
Array
averageMonthlyTransactions
number
Array of objects (PersonDto)
Array
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

dateOfBirth
string <date-time>
name
string
title
string
type
string
Array of objects (PropertyDataDto)
Array
additionalDetails
string (Additional Details)
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

classification
string (Classification)
Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
location
string (Location)
Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
setting
string (Setting)
Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"
type
string (Type)
Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
updatedAt
string <date-time>
uuid
string

Response samples

Content type
application/json
{
}

Patch company data on a profile by UUID.

This endpoint allows you to directly patch company data on a profile without going through a questionnaire.

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

Request Body schema: application/json
non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string

Responses

Request samples

Content type
application/json
{
}

Patch financial data on a profile by UUID.

This endpoint allows you to directly patch financial data on a profile without going through a questionnaire.

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

Request Body schema: application/json
non-empty
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (DebtorDto)
Array
contactId
string
contactNumber
string
debtorDays
number
emailAddress
string
firstName
string
id
required
string
lastName
string
name
string
outstandingAmount
number
outstandingAmountMonthlyAverage
number
outstandingInvoicesCount
number
revenue
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
primaryBank
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (TradingHistoryDto)
Array
debtorsInvoicesDue
number
debtorsOutstanding
number (Trade debtors)
dividends
number
fixedAssets
number (Fixed assets)
netAssets
number (Net assets)
profitNet
required
number (Net profit/loss before tax)
revenue
required
number (Turnover)
year
number
yearEnd
required
number (End of trading year)

Responses

Request samples

Content type
application/json
{
}

Move the given profile object to another Capitalise API key.

Move the given profile object to another Capitalise API key.

This is helpful when you create profiles under your master Capitalise API key, before asking a user to sign into or create their Capitalise account.

Authorizations:
bearerAuth
path Parameters
targetApiKey
required
string

The target API key to move the profile to.

uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

Responses

Set yourself as the owner of an anonymous profile.

Set yourself as the owner of an anonymous profile.

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

Responses

Get profile.

This endpoint allows you to retrieve your full profile object.

Authorizations:
bearerAuth
path Parameters
uuid
required
string
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile UUID.

Responses

Response Schema: application/json
Array of objects (AssetDataDto)
Array
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
existingAgreement
boolean
name
string (Make/model/URL)
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
offeredAsGuarantee
boolean
type
string (Asset type)
Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "STOCK" "TRANSPORTATION"
Array of objects (AssetSecurityDataDto)
Array
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

owner
string (Asset owner)
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
type
string (Asset type)
Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (CompanyInformationDto) non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string
createdAt
string <date-time>
object (EligibilityRequestResponseDto)

(tsType: EligibilityRequestResponseDto, schemaOptions: { exclude: undefined })

appliedProducts
Array of strings
object (AssetFinanceDto)

(tsType: AssetFinanceDto, schemaOptions: { exclude: undefined })

ownsAssets
boolean
object (CommercialPropertyDto)

(tsType: CommercialPropertyDto, schemaOptions: { exclude: undefined })

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
portfolioSize
string
productPropertyType
string
refinancing
boolean
repaymentMethod
string
object (InnovationRequirementsDto) non-empty

(tsType: InnovationRequirementsDto, schemaOptions: { exclude: undefined })

object (GrantsDto) non-empty

(tsType: GrantsDto, schemaOptions: { exclude: undefined })

previousGrantApplication
boolean
uniqueIp
boolean
object (RdTaxClaimDto) non-empty

(tsType: RdTaxClaimDto, schemaOptions: { exclude: undefined })

hasTaxRelief
boolean
isInnovating
boolean
tradingDifficulty
boolean
object (InvoiceFinanceDto)

(tsType: InvoiceFinanceDto, schemaOptions: { exclude: undefined })

customerType
number
raisesInvoices
boolean
object (MerchantCashDto)

(tsType: MerchantCashDto, schemaOptions: { exclude: undefined })

acceptsCommercePayments
boolean
object (RecoveryDto) non-empty

(tsType: RecoveryDto, schemaOptions: { exclude: undefined })

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (CompanyInformationDto) non-empty
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
employeesNumber
number (No. of employees)
hasGovernmentBackedLoans
boolean
incorporatedAt
string <date-time> (Incorporation date)
isGovernmentBacked
boolean
name
string (Company name)
percentageSalesOnline
number (% of sales online)
object (PrimaryContactInformationDto)

(tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined })

object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

email
string (Email address)
inviteClient
boolean
legalRequirements
boolean
name
string (Full name)
number
string (Contact number)
registrationNumber
string (Company Number)
object (CompanyScoreDto)

The credit score and band of the company

grade
string (Grade)
Enum: "A" "B" "C" "D" "E"

The credit band/grade of the company.

Grade title description Grade minimum score Grade maximum score
F Maximum risk Challenging to access finance and a personal guaranteed might be required 2 15
E High risk Challenging to access finance and a personal guaranteed might be required 16 25
D Above average risk Likely to access high value finance but a guarantee may be required 26 50
C Below average risk Likely to access high value finance but a guarantee may be required 51 80
B Low risk Highly likely to access finance at favourable rates 81 90
A Minimum risk Highly likely to access finance at favourable rates 91 100
value
number [ 0 .. 100 ]

The credit score

sector
string (Sector)
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" "NONE" "OTHER" "PRINT_PUBLISHING" "PROFESSIONAL_SERVICES" "PROPERTY" "RECRUITMENT" "RETAIL" "SECURITY_SERVICES" "TRADE" "TRANSPORTATION" "WHOLESALE"
tradingFromDate
string <date-time> (Trading from date)
type
string (Company type)
Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"
object (UnencumberedAssetsDto)

(tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined })

businessOwnsAssets
boolean
guarantees
string
Enum: "BOTH" "BUSINESS" "NONE" "PERSONAL"
isHomeOwnership
boolean
personalGuarantee
boolean
vatStatus
string (VAT status)
Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"
website
string
requestedProducts
Array of strings
object (EligibilityRequestSharedDataDto)

(tsType: EligibilityRequestSharedDataDto, schemaOptions: { exclude: undefined })

backgroundPurpose
required
string (Background and purpose)

What is the business background and the purpose of funds?

declaredForBusinessPurposes
boolean
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
fundingPeriod
number
fundingUrgency
string
previousLoanApplication
boolean
previousLoanDeclined
boolean
tradingImpacted
boolean
useOfFunds
string
sourceQuestionnaireId
string
object (TermLoanDto)

(tsType: TermLoanDto, schemaOptions: { exclude: undefined })

hasTermLoan
boolean
preferredCreditFacility
Array of strings
object (TradeFinanceDto)

(tsType: TradeFinanceDto, schemaOptions: { exclude: undefined })

hasPurchaseOrders
boolean
object (FinancialsDto) non-empty
Example: {"revenue":{"code":"GBP","value":100000}}
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (DebtorDto)
Array
contactId
string
contactNumber
string
debtorDays
number
emailAddress
string
firstName
string
id
required
string
lastName
string
name
string
outstandingAmount
number
outstandingAmountMonthlyAverage
number
outstandingInvoicesCount
number
revenue
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
primaryBank
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
Array of objects (TradingHistoryDto)
Array
debtorsInvoicesDue
number
debtorsOutstanding
number (Trade debtors)
dividends
number
fixedAssets
number (Fixed assets)
netAssets
number (Net assets)
profitNet
required
number (Net profit/loss before tax)
revenue
required
number (Turnover)
year
number
yearEnd
required
number (End of trading year)
object (ProfileCoreApiLegacyDto)

(tsType: ProfileCoreApiLegacyDto, schemaOptions: { exclude: undefined })

entityBusinessId
number
fundingSearchId
number
Array of objects (MerchantCashAdvanceDataDto)
Array
averageMonthlyTransactions
number
Array of objects (PersonDto)
Array
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

dateOfBirth
string <date-time>
name
string
title
string
type
string
Array of objects (PropertyDataDto)
Array
additionalDetails
string (Additional Details)
object (AddressDto)

(tsType: AddressDto, schemaOptions: { exclude: undefined })

city
string (Town)

City

houseNumber
string (Address line 2)

House number

postalCode
string (Post code)

Postal code

province
string (Region)

Province

simpleValue
string

Address in UK format

street
string (Address line 1)

Street

classification
string (Classification)
Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
location
string (Location)
Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
setting
string (Setting)
Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"
type
string (Type)
Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"
object (AnswerCurrencyDto)
Example: {"code":"GBP","value":150000}

(tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined })

code
required
string
Enum: "EUR" "GBP" "ZAR"
value
required
number
updatedAt
string <date-time>
uuid
string

Response samples

Content type
application/json
{
}

Questionnaires

Get full questionnaire JSON schema by ID

The response payload includes the fields type hint and validations.

Authorizations:
bearerAuth
path Parameters
questionnaireId
required
string

Responses

Create or update questionnaire answers in full

This endpoint allows you to put profile questionnaire answers by UUID. Please bear in mind that you will have to submit all the required answers by the questionnaire. For partial updates please use the patch endpoint.

Authorizations:
bearerAuth
path Parameters
profileId
required
string <uuid>
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile ID

questionnaireId
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"

Questionnaire ID

Request Body schema: application/json
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?

Responses

Request samples

Content type
application/json
Example
{
}

Update a selection of questionnaire answers

This endpoint allows you to patch profile questionnaire answers by UUID.

Authorizations:
bearerAuth
path Parameters
profileId
required
string <uuid>
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile ID

questionnaireId
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"

Questionnaire ID

Request Body schema: application/json
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?

Responses

Request samples

Content type
application/json
Example
{
}

Get questionnaire answers.

This endpoint allows you to get the questionnaire answers you have submitted by UUID.

Authorizations:
bearerAuth
path Parameters
profileId
required
string <uuid>
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile ID

questionnaireId
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"

Questionnaire ID

Responses

Response Schema: application/json
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?

Response samples

Content type
application/json
Example
{
}

Delete questionnaire answers.

This endpoint allows you to delete profile questionnaire answers by UUID.

Authorizations:
bearerAuth
path Parameters
profileId
required
string <uuid>
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile ID

questionnaireId
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"

Questionnaire ID

query Parameters
answerKey
Array of strings

Responses

Allows getting profile questionnaire JSON schema by UUID.

Allows getting profile questionnaire JSON schema by UUID.

The response payload includes the fields type hint and validations.

Authorizations:
bearerAuth
path Parameters
profileId
required
string <uuid>
Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45

Profile ID

questionnaireId
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"

Questionnaire ID

Responses

Allows getting the entire questionnaire by ID.

Fetch a list of questions required to begin product matching. You can optionally prime the questionnaire responses by using the profile endpoints and then fetch all questions.

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: introducer-working-capital

Questionnaire ID.

Responses

Response Schema: application/json
id
string
object (QuestionKeysDto)

(tsType: QuestionKeysDto, schemaOptions: { exclude: undefined })

object (QuestionKeysDto)

(tsType: QuestionKeysDto, schemaOptions: { exclude: undefined })

title
string

Response samples

Content type
application/json
{
}

Allows getting a set of questionnaire objects.

Fetch a list of questionnaires required to begin product matching.

Authorizations:
bearerAuth

Responses

Response Schema: application/json
Array
id
string
object (QuestionKeysDto)

(tsType: QuestionKeysDto, schemaOptions: { exclude: undefined })

object (QuestionKeysDto)

(tsType: QuestionKeysDto, schemaOptions: { exclude: undefined })

title
string

Response samples

Content type
application/json
[
]