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

ApplicationController_create

header Parameters

Authorization

required

string <JWT Token>

The token generated from the API key

Request Body schema: application/json

non-empty

One of

non-empty

assetExistingAgreement

boolean

assetType

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

averageCardSales

number

businessOwnsAssets

boolean

businessPurposes

boolean

cardPayments

boolean

clientEmail

string

clientName

string

clientNumber

string

clientType

number

object (CurrencyDto)

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

fundingAsset

boolean

fundingPeriod

number

fundingUrgency

string

Enum: "ASAP" "JUST_BROWSING" "ONE_MONTH" "ONE_WEEK" "REFINANCING"

governmentBackedLoansExist

boolean

homeOwnership

boolean

legalRequirements

boolean

object (CurrencyDto)

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

object (CurrencyDto)

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

personalGuarantee

boolean

purchaseOrders

boolean

raiseInvoices

boolean

object (CurrencyDto)

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

type

string

Default: "business-all-funding-products"

Value: "business-all-funding-products"

useOfFunds

string

Enum: "ACQUIRING_BUSINESS" "BUSINESS_EXPANSION" "CASH_FLOW" "EQUIPMENT_ASSET_FINANCE" "IMPORT_EXPORT" "PURCHASING_PROPERTY" "PURCHASING_STOCK" "REFINANCING_DEBT" "STARTING_BUSINESS" "TAX_BILL_DUE"

Responses

Response Schema: application/json

non-empty

One of

non-empty

assetExistingAgreement

boolean

assetType

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

averageCardSales

number

businessOwnsAssets

boolean

businessPurposes

boolean

cardPayments

boolean

clientEmail

string

clientName

string

clientNumber

string

clientType

number

object (CurrencyDto)

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

fundingAsset

boolean

fundingPeriod

number

fundingUrgency

string

Enum: "ASAP" "JUST_BROWSING" "ONE_MONTH" "ONE_WEEK" "REFINANCING"

homeOwnership

boolean

id

required

string

legalRequirements

boolean

object (CurrencyDto)

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

object (CurrencyDto)

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

personalGuarantee

boolean

purchaseOrders

boolean

raiseInvoices

boolean

object (CurrencyDto)

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

tradingAddress

string

type

required

string

Default: "introducer-all-funding-products"

Value: "introducer-all-funding-products"

useOfFunds

string

Enum: "ACQUIRING_BUSINESS" "BUSINESS_EXPANSION" "CASH_FLOW" "EQUIPMENT_ASSET_FINANCE" "IMPORT_EXPORT" "PURCHASING_PROPERTY" "PURCHASING_STOCK" "REFINANCING_DEBT" "STARTING_BUSINESS" "TAX_BILL_DUE"

Request samples

Payload

Content type

application/json

Example

PatchApplicationRequestBusinessAllFundingProductsDto

{"type": "business-all-funding-products",
"fundingUrgency": "ASAP",
"useOfFunds": "ACQUIRING_BUSINESS",
"assetType": "BUSINESS",
"clientName": "string",
"clientEmail": "string",
"clientNumber": "string",
"legalRequirements": true,
"businessPurposes": true,
"fundingAmount": {"code": "EUR",
"value": 0
},
"fundingPeriod": 0,
"clientType": 0,
"averageCardSales": 0,
"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"netAssetCost": {"code": "EUR",
"value": 0
},
"cardPayments": true,
"governmentBackedLoansExist": true,
"homeOwnership": true,
"personalGuarantee": true,
"businessOwnsAssets": true,
"purchaseOrders": true,
"assetExistingAgreement": true,
"fundingAsset": true,
"raiseInvoices": true
}

Response samples

201

Content type

application/json

Example

ApplicationResponseIntroducerAllFundingProductsDto

{"type": "introducer-all-funding-products",
"fundingUrgency": "ASAP",
"useOfFunds": "ACQUIRING_BUSINESS",
"assetType": "BUSINESS",
"id": "string",
"clientName": "string",
"clientEmail": "string",
"clientNumber": "string",
"legalRequirements": true,
"businessPurposes": true,
"fundingAmount": {"code": "EUR",
"value": 0
},
"fundingPeriod": 0,
"clientType": 0,
"averageCardSales": 0,
"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"netAssetCost": {"code": "EUR",
"value": 0
},
"cardPayments": true,
"raiseInvoices": true,
"fundingAsset": true,
"assetExistingAgreement": true,
"purchaseOrders": true,
"businessOwnsAssets": true,
"personalGuarantee": true,
"homeOwnership": true,
"tradingAddress": "string"
}

ApplicationSignUpController_generateContinueUrl

path Parameters

applicationId

required

string

header Parameters

Authorization

required

string <JWT Token>

The token generated from the API key

Request Body schema: application/json

clickId

string (ClickId)

Responses

Response Schema: application/json

continueUrl

required

string

Request samples

Payload

Content type

application/json

{"clickId": "string"
}

Response samples

201

Content type

application/json

{"continueUrl": "string"
}

ApplicationSignUpController_validateContinueUrl

query Parameters

continueUrl

required

string

Responses

ApplicationController_getMatches

path Parameters

applicationId

required

string

header Parameters

Authorization

required

string <JWT Token>

The token generated from the API key

Responses

Response Schema: application/json

required

Array of objects (ApplicationFundingMatchDto)

Array

object (FundingMatchFeesDto)

arrangementFees	number
earlyRepaymentFees	number
exitFees	number

instantOffer

required

boolean

required

object (FundingMatchLenderDto)

average	string Enum: "AVERAGE" "EXPENSIVE" "LOW" "MOST_EXPENSIVE"
description	string
documents	Array of strings
id required	number
logo	string
name required	string
responseTime	number

object (FundingMatchLikelihoodDto)

value

required

number

product

required

string

Enum: "ASSET_BACKED_FINANCE" "COMMERCIAL_PROPERTY" "FIXED_LOAN_TERMS" "INVOICE_FINANCE" "MERCHANT_CASH_ADVANCE" "TERM_LOAN" "TRADE_FINANCE"

numberOfMatches

required

number

Response samples

200

Content type

application/json

{"numberOfMatches": 0,
"matches": [{"lender": {"id": 0,
"name": "string",
"logo": "string",
"description": "string",
"average": "AVERAGE",
"responseTime": 0,
"documents": ["string"
]
},
"product": "ASSET_BACKED_FINANCE",
"fees": {"arrangementFees": 0,
"earlyRepaymentFees": 0,
"exitFees": 0
},
"likelihood": {"value": 0
},
"instantOffer": true
}
]
}

ApplicationController_getPreselectedOffers

path Parameters

applicationId

required

string

header Parameters

Authorization

required

string <JWT Token>

The token generated from the API key

Responses

Response Schema: application/json

Array

applicationUrl

string

object (ApplicationOfferAssetFinanceDto)

additionalFees	string
advanceAmount	number
arrangementFee	number
commissionAmount	number
cost	number
deposit	number
description	string
interestCharge	string Enum: "ANNUAL_RATE" "DAILY_RATE" "FACTOR_RATE" "FLAT_RATE" "MONTHLY_RATE"
likelihoodOfAcceptance	number
likelihoodOfRate	number
monthlyRepayment	number
optionToPurchaseFee	number
productOption	string Enum: "FINANCE_LEASE" "HIRE_PURCHASE"
promotion	string
rate	number
representativeAPR	number
term	number
totalPrice	number
vat	number

object (ApplicationOfferCommercialPropertyDto)

arrangementFee	number
commissionAmount	number
dealTerm	number
exitFee	number
fundingAmount	number
interestCharge	string Enum: "ANNUAL_RATE" "DAILY_RATE" "FACTOR_RATE" "FLAT_RATE" "MONTHLY_RATE"
interestRate	number
ltv	number
mortgageTerm	number
productType	string Enum: "BTL" "INTEREST_ONLY" "PARTIALLY_AMORTISING" "REPAYMENT"
propertyChargeAddress	string
rateType	string Enum: "FIXED" "VARIABLE"
valuationFee	number

createdAt

required

string <date-time>

expiryDate

string <date-time>

id

required

string

object (ApplicationOfferInvoiceFinanceDto)

additionalFees	string
advanceRate	number
commissionAmount	number
concentrationLimit	number
confidential	boolean
contractLength	number
creditInsurance	number
creditInsuranceRequired	boolean
discountFee	number
facility	string Enum: "DISCOUNTING" "FACTORING"
likelihoodOfAcceptance	number
likelihoodOfRate	number
maximumCreditLine	number
minimumCreditLine	number
minimumMonthlyFee	number
promotion	string
selective	boolean
serviceFee	number

isPreselected

boolean

object (ApplicationOfferMerchantCashAdvanceDto)

commissionAmount	number
fundingAmount	number
likelihoodOfAcceptance	number
likelihoodOfRate	number
promotion	string
ratio	number
sweep	number
totalFees	number
totalRepayment	number

productType

string

Enum: "ASSET_BACKED_FINANCE" "COMMERCIAL_PROPERTY" "FIXED_LOAN_TERMS" "INVOICE_FINANCE" "MERCHANT_CASH_ADVANCE" "TERM_LOAN" "TRADE_FINANCE"

profileUuid

string

publicComment

string

reference

string

securityRequired

Array of strings

Items Enum: "DEBENTURE" "PERSONAL_GUARANTEE" "PROPERTY" "UNSECURED"

status

required

string

Enum: "FINAL" "INDICATIVE" "PRE_SELECTED"

object (ApplicationOfferTermLoanDto)

arrangementFee	number
commissionAmount	number
interestCharge	string Enum: "ANNUAL_RATE" "DAILY_RATE" "FACTOR_RATE" "FLAT_RATE" "MONTHLY_RATE"
interestRate	number
likelihoodOfAcceptance	number
likelihoodOfRate	number
maximumAmount	number
minimumAmount	number
monthlyRepayment	number
promotion	string
rate	number
representativeAPR	number
term	number
totalFees	number
totalRepayment	number

object (ApplicationOfferTradeFinanceDto)

additionalFees	string
advanceRate	number
commissionAmount	number
contractLength	number
discountFee	number
likelihoodOfAcceptance	number
likelihoodOfRate	number
maximumCreditLine	number
minimumCreditLine	number
promotion	string
serviceFee	number

type

required

string

Enum: "INSTANT_OFFER" "MANUAL_OFFER"

updatedAt

string <date-time>

Response samples

200

Content type

application/json

[{"id": "string",
"type": "INSTANT_OFFER",
"isPreselected": true,
"status": "FINAL",
"productType": "ASSET_BACKED_FINANCE",
"applicationUrl": "string",
"profileUuid": "string",
"reference": "string",
"publicComment": "string",
"securityRequired": ["DEBENTURE"
],
"assetFinance": {"advanceAmount": 0,
"arrangementFee": 0,
"commissionAmount": 0,
"interestCharge": "ANNUAL_RATE",
"rate": 0,
"term": 0,
"deposit": 0,
"productOption": "FINANCE_LEASE",
"vat": 0,
"cost": 0,
"totalPrice": 0,
"description": "string",
"promotion": "string",
"monthlyRepayment": 0,
"additionalFees": "string",
"optionToPurchaseFee": 0,
"likelihoodOfRate": 0,
"likelihoodOfAcceptance": 0,
"representativeAPR": 0
},
"invoiceFinance": {"commissionAmount": 0,
"maximumCreditLine": 0,
"minimumCreditLine": 0,
"serviceFee": 0,
"discountFee": 0,
"advanceRate": 0,
"facility": "DISCOUNTING",
"contractLength": 0,
"additionalFees": "string",
"minimumMonthlyFee": 0,
"concentrationLimit": 0,
"creditInsurance": 0,
"creditInsuranceRequired": true,
"selective": true,
"confidential": true,
"promotion": "string",
"likelihoodOfRate": 0,
"likelihoodOfAcceptance": 0
},
"merchantCashAdvance": {"commissionAmount": 0,
"fundingAmount": 0,
"sweep": 0,
"totalRepayment": 0,
"ratio": 0,
"promotion": "string",
"likelihoodOfRate": 0,
"likelihoodOfAcceptance": 0,
"totalFees": 0
},
"termLoan": {"maximumAmount": 0,
"arrangementFee": 0,
"commissionAmount": 0,
"interestCharge": "ANNUAL_RATE",
"rate": 0,
"minimumAmount": 0,
"interestRate": 0,
"representativeAPR": 0,
"term": 0,
"monthlyRepayment": 0,
"totalRepayment": 0,
"promotion": "string",
"likelihoodOfRate": 0,
"likelihoodOfAcceptance": 0,
"totalFees": 0
},
"tradeFinance": {"commissionAmount": 0,
"maximumCreditLine": 0,
"minimumCreditLine": 0,
"serviceFee": 0,
"discountFee": 0,
"additionalFees": "string",
"advanceRate": 0,
"contractLength": 0,
"promotion": "string",
"likelihoodOfRate": 0,
"likelihoodOfAcceptance": 0
},
"commercialProperty": {"fundingAmount": 0,
"arrangementFee": 0,
"commissionAmount": 0,
"interestCharge": "ANNUAL_RATE",
"interestRate": 0,
"productType": "BTL",
"mortgageTerm": 0,
"dealTerm": 0,
"rateType": "FIXED",
"ltv": 0,
"valuationFee": 0,
"exitFee": 0,
"propertyChargeAddress": "string"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"expiryDate": "2019-08-24T14:15:22Z"
}
]

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

Array of objects (AssetDataDto)

Array

object (CurrencyDto)

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

existingAgreement

boolean

name

string

required

object (CurrencyDto)

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

offeredAsGuarantee

boolean

type

required

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

Array of objects (AssetSecurityDataDto)

Array

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

owner

required

string

object (CurrencyDto)

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

type

required

string

Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"

object (CurrencyDto)

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

required

object (CompanyInformationDto)

object (CurrencyDto)

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

employeesNumber

number

hasGovernmentBackedLoans

boolean

isGovernmentBacked

boolean

object (LegalNoticesDto)

object (CompanyLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

object (DirectorsLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

name

string

percentageSalesOnline

number

object (PrimaryContactInformationDto)

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

email

required

string

inviteClient

boolean

legalRequirements

boolean

name

required

string

number

required

string

registrationNumber

required

string

object (CompanyScoreDto)

changedAt

string

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

industryAverageGrade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

lastAssessedAt

string

object (PreviousCompanyScoreDto)

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

value

number

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"

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

type

string

Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

object (UnencumberedAssetsDto)

businessOwnsAssets	boolean
guarantees	string Enum: "BUSINESS" "PERSONAL"
isHomeOwnership	boolean
personalGuarantee	boolean

vatStatus

string

Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"

website

string

object (FinancialsDto)

object (CurrencyDto)

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

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (DebtorDto)

Array

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

object (CurrencyDto)

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

companyName

string

contactId

required

string

contactNumber

string

debtorDays

number

emailAddress

required

string

firstName

required

string

id

required

string

lastName

string

name

required

string

outstandingAmount

required

number

outstandingAmountMonthlyAverage

required

number

outstandingInvoicesCount

required

number

revenue

number

object (CurrencyDto)

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

grossProfitMargin

number

invoicesOutstanding

number

object (CurrencyDto)

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

numberOfCustomers

number

paymentTerms

number

primaryBank

number

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (TradingHistoryDto)

Array

debtorsInvoicesDue	number
debtorsOutstanding	number
dividends	number
fixedAssets	number
netAssets	number
profitNet required	number
revenue required	number
year	number
yearEnd required	number

Array of objects (MerchantCashAdvanceDataDto)

Array

averageMonthlyTransactions	number
monthsOnBusinessLease	number
terminalId	string
type	string Enum: "Amazon" "Deliveroo" "Ebay" "Etsy" "Ingenico" "Izettle" "Other" "PB payment solutions" "Paylevel" "Paypal here" "Shopify" "SmartTrade" "Sumsup" "Transax" "Uber" "Verifone" "Worldpay"

Array of objects (PropertyDataDto)

Array

additionalDetails

string

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

classification

string

Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"

required

object (CurrencyDto)

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

location

string

Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"

required

object (CurrencyDto)

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

setting

string

Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"

type

string

Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"

required

object (CurrencyDto)

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

Array of objects (TradeReferenceDto)

Array

companyName required	string
contactEmail	string
contactName required	string
contactNumber required	string

Responses

Response Schema: application/json

Array of objects (AssetDataDto)

Array

object (CurrencyDto)

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

existingAgreement

boolean

name

string

required

object (CurrencyDto)

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

offeredAsGuarantee

boolean

type

required

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

Array of objects (AssetSecurityDataDto)

Array

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

owner

required

string

object (CurrencyDto)

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

type

required

string

Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"

object (CurrencyDto)

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

object (CompanyInformationDto)

object (CurrencyDto)

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

employeesNumber

number

hasGovernmentBackedLoans

boolean

isGovernmentBacked

boolean

object (LegalNoticesDto)

object (CompanyLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

object (DirectorsLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

name

string

percentageSalesOnline

number

object (PrimaryContactInformationDto)

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

email

required

string

inviteClient

boolean

legalRequirements

boolean

name

required

string

number

required

string

registrationNumber

required

string

object (CompanyScoreDto)

changedAt

string

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

industryAverageGrade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

lastAssessedAt

string

object (PreviousCompanyScoreDto)

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

value

number

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"

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

type

string

Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

object (UnencumberedAssetsDto)

businessOwnsAssets	boolean
guarantees	string Enum: "BUSINESS" "PERSONAL"
isHomeOwnership	boolean
personalGuarantee	boolean

vatStatus

string

Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"

website

string

createdAt

required

string

object (FinancialsDto)

object (CurrencyDto)

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

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (DebtorDto)

Array

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

object (CurrencyDto)

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

companyName

string

contactId

required

string

contactNumber

string

debtorDays

number

emailAddress

required

string

firstName

required

string

id

required

string

lastName

string

name

required

string

outstandingAmount

required

number

outstandingAmountMonthlyAverage

required

number

outstandingInvoicesCount

required

number

revenue

number

object (CurrencyDto)

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

grossProfitMargin

number

invoicesOutstanding

number

object (CurrencyDto)

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

numberOfCustomers

number

paymentTerms

number

primaryBank

number

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (TradingHistoryDto)

Array

debtorsInvoicesDue	number
debtorsOutstanding	number
dividends	number
fixedAssets	number
netAssets	number
profitNet required	number
revenue required	number
year	number
yearEnd required	number

Array of objects (MerchantCashAdvanceDataDto)

Array

averageMonthlyTransactions	number
monthsOnBusinessLease	number
terminalId	string
type	string Enum: "Amazon" "Deliveroo" "Ebay" "Etsy" "Ingenico" "Izettle" "Other" "PB payment solutions" "Paylevel" "Paypal here" "Shopify" "SmartTrade" "Sumsup" "Transax" "Uber" "Verifone" "Worldpay"

Array of objects (PropertyDataDto)

Array

additionalDetails

string

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

classification

string

Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"

required

object (CurrencyDto)

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

location

string

Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"

required

object (CurrencyDto)

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

setting

string

Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"

type

string

Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"

required

object (CurrencyDto)

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

Array of objects (TradeReferenceDto)

Array

companyName required	string
contactEmail	string
contactName required	string
contactNumber required	string

updatedAt

required

string

Request samples

Payload

Content type

application/json

{"companyInformation": {"type": "LIMITED_COMPANY",
"sector": "AGRICULTURE",
"vatStatus": "NOT_REGISTERED",
"name": "string",
"registrationNumber": "string",
"score": {"grade": "A",
"industryAverageGrade": "A",
"value": 0,
"changedAt": "string",
"lastAssessedAt": "string",
"previous": {"grade": "A"
}
},
"creditLimit": {"code": "EUR",
"value": 0
},
"unencumberedAssets": {"guarantees": "BUSINESS",
"isHomeOwnership": true,
"personalGuarantee": true,
"businessOwnsAssets": true
},
"isGovernmentBacked": true,
"hasGovernmentBackedLoans": true,
"employeesNumber": 0,
"percentageSalesOnline": 0,
"website": "string",
"legalNotices": {"company": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
},
"directors": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
}
},
"primaryContactInformation": {"email": "string",
"name": "string",
"number": "string",
"inviteClient": true,
"legalRequirements": true,
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"tradingAddress": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"financials": {"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"bankInterest": {"code": "EUR",
"value": 0
},
"depreciation": {"code": "EUR",
"value": 0
},
"amortisation": {"code": "EUR",
"value": 0
},
"tradingHistory": [{"debtorsInvoicesDue": 0,
"debtorsOutstanding": 0,
"fixedAssets": 0,
"netAssets": 0,
"profitNet": 0,
"dividends": 0,
"revenue": 0,
"year": 0,
"yearEnd": 0
}
],
"debtors": [{"id": "string",
"contactId": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"emailAddress": "string",
"outstandingAmount": 0,
"outstandingAmountMonthlyAverage": 0,
"outstandingInvoicesCount": 0,
"contactNumber": "string",
"debtorDays": 0,
"revenue": 0,
"averageMonthlyIncome": {"code": "EUR",
"value": 0
},
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
}
],
"primaryBank": 0,
"tradeDebtors": {"code": "EUR",
"value": 0
},
"paymentTerms": 0,
"invoicesOutstanding": 0,
"numberOfCustomers": 0,
"currentValueConfirmedOrders": {"code": "EUR",
"value": 0
},
"grossProfitMargin": 0
},
"properties": [{"type": "FLATS",
"location": "EUROPE",
"setting": "CITY",
"classification": "COMMERCIAL",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"outstandingDebt": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"additionalDetails": "string"
}
],
"assets": [{"type": "BUSINESS",
"name": "string",
"offeredAsGuarantee": true,
"netCost": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"existingAgreement": true
}
],
"assetsForSecurity": [{"type": "MAIN_PROPERTY",
"owner": "string",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"totalDebt": {"code": "EUR",
"value": 0
}
}
],
"merchantCashAdvance": [{"type": "Amazon",
"averageMonthlyTransactions": 0,
"terminalId": "string",
"monthsOnBusinessLease": 0
}
],
"tradeReferences": [{"companyName": "string",
"contactName": "string",
"contactNumber": "string",
"contactEmail": "string"
}
]
}

Response samples

201

Content type

application/json

{"companyInformation": {"type": "LIMITED_COMPANY",
"sector": "AGRICULTURE",
"vatStatus": "NOT_REGISTERED",
"name": "string",
"registrationNumber": "string",
"score": {"grade": "A",
"industryAverageGrade": "A",
"value": 0,
"changedAt": "string",
"lastAssessedAt": "string",
"previous": {"grade": "A"
}
},
"creditLimit": {"code": "EUR",
"value": 0
},
"unencumberedAssets": {"guarantees": "BUSINESS",
"isHomeOwnership": true,
"personalGuarantee": true,
"businessOwnsAssets": true
},
"isGovernmentBacked": true,
"hasGovernmentBackedLoans": true,
"employeesNumber": 0,
"percentageSalesOnline": 0,
"website": "string",
"legalNotices": {"company": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
},
"directors": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
}
},
"primaryContactInformation": {"email": "string",
"name": "string",
"number": "string",
"inviteClient": true,
"legalRequirements": true,
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"tradingAddress": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"financials": {"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"bankInterest": {"code": "EUR",
"value": 0
},
"depreciation": {"code": "EUR",
"value": 0
},
"amortisation": {"code": "EUR",
"value": 0
},
"tradingHistory": [{"debtorsInvoicesDue": 0,
"debtorsOutstanding": 0,
"fixedAssets": 0,
"netAssets": 0,
"profitNet": 0,
"dividends": 0,
"revenue": 0,
"year": 0,
"yearEnd": 0
}
],
"debtors": [{"id": "string",
"contactId": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"emailAddress": "string",
"outstandingAmount": 0,
"outstandingAmountMonthlyAverage": 0,
"outstandingInvoicesCount": 0,
"contactNumber": "string",
"debtorDays": 0,
"revenue": 0,
"averageMonthlyIncome": {"code": "EUR",
"value": 0
},
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
}
],
"primaryBank": 0,
"tradeDebtors": {"code": "EUR",
"value": 0
},
"paymentTerms": 0,
"invoicesOutstanding": 0,
"numberOfCustomers": 0,
"currentValueConfirmedOrders": {"code": "EUR",
"value": 0
},
"grossProfitMargin": 0
},
"properties": [{"type": "FLATS",
"location": "EUROPE",
"setting": "CITY",
"classification": "COMMERCIAL",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"outstandingDebt": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"additionalDetails": "string"
}
],
"assets": [{"type": "BUSINESS",
"name": "string",
"offeredAsGuarantee": true,
"netCost": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"existingAgreement": true
}
],
"assetsForSecurity": [{"type": "MAIN_PROPERTY",
"owner": "string",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"totalDebt": {"code": "EUR",
"value": 0
}
}
],
"merchantCashAdvance": [{"type": "Amazon",
"averageMonthlyTransactions": 0,
"terminalId": "string",
"monthsOnBusinessLease": 0
}
],
"tradeReferences": [{"companyName": "string",
"contactName": "string",
"contactNumber": "string",
"contactEmail": "string"
}
],
"createdAt": "string",
"updatedAt": "string"
}

Get 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

Responses

Response Schema: application/json

Array of objects (AssetDataDto)

Array

object (CurrencyDto)

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

existingAgreement

boolean

name

string

required

object (CurrencyDto)

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

offeredAsGuarantee

boolean

type

required

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

Array of objects (AssetSecurityDataDto)

Array

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

owner

required

string

object (CurrencyDto)

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

type

required

string

Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"

object (CurrencyDto)

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

object (CompanyInformationDto)

object (CurrencyDto)

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

employeesNumber

number

hasGovernmentBackedLoans

boolean

isGovernmentBacked

boolean

object (LegalNoticesDto)

object (CompanyLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

object (DirectorsLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

name

string

percentageSalesOnline

number

object (PrimaryContactInformationDto)

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

email

required

string

inviteClient

boolean

legalRequirements

boolean

name

required

string

number

required

string

registrationNumber

required

string

object (CompanyScoreDto)

changedAt

string

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

industryAverageGrade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

lastAssessedAt

string

object (PreviousCompanyScoreDto)

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

value

number

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"

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

type

string

Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

object (UnencumberedAssetsDto)

businessOwnsAssets	boolean
guarantees	string Enum: "BUSINESS" "PERSONAL"
isHomeOwnership	boolean
personalGuarantee	boolean

vatStatus

string

Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"

website

string

createdAt

required

string

object (FinancialsDto)

object (CurrencyDto)

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

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (DebtorDto)

Array

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

object (CurrencyDto)

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

companyName

string

contactId

required

string

contactNumber

string

debtorDays

number

emailAddress

required

string

firstName

required

string

id

required

string

lastName

string

name

required

string

outstandingAmount

required

number

outstandingAmountMonthlyAverage

required

number

outstandingInvoicesCount

required

number

revenue

number

object (CurrencyDto)

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

grossProfitMargin

number

invoicesOutstanding

number

object (CurrencyDto)

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

numberOfCustomers

number

paymentTerms

number

primaryBank

number

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (TradingHistoryDto)

Array

debtorsInvoicesDue	number
debtorsOutstanding	number
dividends	number
fixedAssets	number
netAssets	number
profitNet required	number
revenue required	number
year	number
yearEnd required	number

Array of objects (MerchantCashAdvanceDataDto)

Array

averageMonthlyTransactions	number
monthsOnBusinessLease	number
terminalId	string
type	string Enum: "Amazon" "Deliveroo" "Ebay" "Etsy" "Ingenico" "Izettle" "Other" "PB payment solutions" "Paylevel" "Paypal here" "Shopify" "SmartTrade" "Sumsup" "Transax" "Uber" "Verifone" "Worldpay"

Array of objects (PropertyDataDto)

Array

additionalDetails

string

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

classification

string

Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"

required

object (CurrencyDto)

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

location

string

Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"

required

object (CurrencyDto)

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

setting

string

Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"

type

string

Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"

required

object (CurrencyDto)

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

Array of objects (TradeReferenceDto)

Array

companyName required	string
contactEmail	string
contactName required	string
contactNumber required	string

updatedAt

required

string

Response samples

200

Content type

application/json

{"companyInformation": {"type": "LIMITED_COMPANY",
"sector": "AGRICULTURE",
"vatStatus": "NOT_REGISTERED",
"name": "string",
"registrationNumber": "string",
"score": {"grade": "A",
"industryAverageGrade": "A",
"value": 0,
"changedAt": "string",
"lastAssessedAt": "string",
"previous": {"grade": "A"
}
},
"creditLimit": {"code": "EUR",
"value": 0
},
"unencumberedAssets": {"guarantees": "BUSINESS",
"isHomeOwnership": true,
"personalGuarantee": true,
"businessOwnsAssets": true
},
"isGovernmentBacked": true,
"hasGovernmentBackedLoans": true,
"employeesNumber": 0,
"percentageSalesOnline": 0,
"website": "string",
"legalNotices": {"company": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
},
"directors": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
}
},
"primaryContactInformation": {"email": "string",
"name": "string",
"number": "string",
"inviteClient": true,
"legalRequirements": true,
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"tradingAddress": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"financials": {"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"bankInterest": {"code": "EUR",
"value": 0
},
"depreciation": {"code": "EUR",
"value": 0
},
"amortisation": {"code": "EUR",
"value": 0
},
"tradingHistory": [{"debtorsInvoicesDue": 0,
"debtorsOutstanding": 0,
"fixedAssets": 0,
"netAssets": 0,
"profitNet": 0,
"dividends": 0,
"revenue": 0,
"year": 0,
"yearEnd": 0
}
],
"debtors": [{"id": "string",
"contactId": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"emailAddress": "string",
"outstandingAmount": 0,
"outstandingAmountMonthlyAverage": 0,
"outstandingInvoicesCount": 0,
"contactNumber": "string",
"debtorDays": 0,
"revenue": 0,
"averageMonthlyIncome": {"code": "EUR",
"value": 0
},
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
}
],
"primaryBank": 0,
"tradeDebtors": {"code": "EUR",
"value": 0
},
"paymentTerms": 0,
"invoicesOutstanding": 0,
"numberOfCustomers": 0,
"currentValueConfirmedOrders": {"code": "EUR",
"value": 0
},
"grossProfitMargin": 0
},
"properties": [{"type": "FLATS",
"location": "EUROPE",
"setting": "CITY",
"classification": "COMMERCIAL",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"outstandingDebt": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"additionalDetails": "string"
}
],
"assets": [{"type": "BUSINESS",
"name": "string",
"offeredAsGuarantee": true,
"netCost": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"existingAgreement": true
}
],
"assetsForSecurity": [{"type": "MAIN_PROPERTY",
"owner": "string",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"totalDebt": {"code": "EUR",
"value": 0
}
}
],
"merchantCashAdvance": [{"type": "Amazon",
"averageMonthlyTransactions": 0,
"terminalId": "string",
"monthsOnBusinessLease": 0
}
],
"tradeReferences": [{"companyName": "string",
"contactName": "string",
"contactNumber": "string",
"contactEmail": "string"
}
],
"createdAt": "string",
"updatedAt": "string"
}

Update 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

Array of objects (AssetDataDto)

Array

object (CurrencyDto)

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

existingAgreement

boolean

name

string

required

object (CurrencyDto)

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

offeredAsGuarantee

boolean

type

required

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

Array of objects (AssetSecurityDataDto)

Array

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

owner

required

string

object (CurrencyDto)

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

type

required

string

Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"

object (CurrencyDto)

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

object (CompanyInformationDto)

object (CurrencyDto)

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

employeesNumber

number

hasGovernmentBackedLoans

boolean

isGovernmentBacked

boolean

object (LegalNoticesDto)

object (CompanyLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

object (DirectorsLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

name

string

percentageSalesOnline

number

object (PrimaryContactInformationDto)

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

email

required

string

inviteClient

boolean

legalRequirements

boolean

name

required

string

number

required

string

registrationNumber

required

string

object (CompanyScoreDto)

changedAt

string

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

industryAverageGrade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

lastAssessedAt

string

object (PreviousCompanyScoreDto)

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

value

number

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"

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

type

string

Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

object (UnencumberedAssetsDto)

businessOwnsAssets	boolean
guarantees	string Enum: "BUSINESS" "PERSONAL"
isHomeOwnership	boolean
personalGuarantee	boolean

vatStatus

string

Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"

website

string

object (FinancialsDto)

object (CurrencyDto)

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

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (DebtorDto)

Array

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

object (CurrencyDto)

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

companyName

string

contactId

required

string

contactNumber

string

debtorDays

number

emailAddress

required

string

firstName

required

string

id

required

string

lastName

string

name

required

string

outstandingAmount

required

number

outstandingAmountMonthlyAverage

required

number

outstandingInvoicesCount

required

number

revenue

number

object (CurrencyDto)

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

grossProfitMargin

number

invoicesOutstanding

number

object (CurrencyDto)

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

numberOfCustomers

number

paymentTerms

number

primaryBank

number

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (TradingHistoryDto)

Array

debtorsInvoicesDue	number
debtorsOutstanding	number
dividends	number
fixedAssets	number
netAssets	number
profitNet required	number
revenue required	number
year	number
yearEnd required	number

Array of objects (MerchantCashAdvanceDataDto)

Array

averageMonthlyTransactions	number
monthsOnBusinessLease	number
terminalId	string
type	string Enum: "Amazon" "Deliveroo" "Ebay" "Etsy" "Ingenico" "Izettle" "Other" "PB payment solutions" "Paylevel" "Paypal here" "Shopify" "SmartTrade" "Sumsup" "Transax" "Uber" "Verifone" "Worldpay"

Array of objects (PropertyDataDto)

Array

additionalDetails

string

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

classification

string

Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"

required

object (CurrencyDto)

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

location

string

Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"

required

object (CurrencyDto)

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

setting

string

Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"

type

string

Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"

required

object (CurrencyDto)

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

Array of objects (TradeReferenceDto)

Array

companyName required	string
contactEmail	string
contactName required	string
contactNumber required	string

Responses

Response Schema: application/json

Array of objects (AssetDataDto)

Array

object (CurrencyDto)

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

existingAgreement

boolean

name

string

required

object (CurrencyDto)

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

offeredAsGuarantee

boolean

type

required

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

Array of objects (AssetSecurityDataDto)

Array

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

owner

required

string

object (CurrencyDto)

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

type

required

string

Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"

object (CurrencyDto)

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

object (CompanyInformationDto)

object (CurrencyDto)

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

employeesNumber

number

hasGovernmentBackedLoans

boolean

isGovernmentBacked

boolean

object (LegalNoticesDto)

object (CompanyLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

object (DirectorsLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

name

string

percentageSalesOnline

number

object (PrimaryContactInformationDto)

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

email

required

string

inviteClient

boolean

legalRequirements

boolean

name

required

string

number

required

string

registrationNumber

required

string

object (CompanyScoreDto)

changedAt

string

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

industryAverageGrade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

lastAssessedAt

string

object (PreviousCompanyScoreDto)

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

value

number

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"

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

type

string

Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

object (UnencumberedAssetsDto)

businessOwnsAssets	boolean
guarantees	string Enum: "BUSINESS" "PERSONAL"
isHomeOwnership	boolean
personalGuarantee	boolean

vatStatus

string

Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"

website

string

createdAt

required

string

object (FinancialsDto)

object (CurrencyDto)

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

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (DebtorDto)

Array

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

object (CurrencyDto)

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

companyName

string

contactId

required

string

contactNumber

string

debtorDays

number

emailAddress

required

string

firstName

required

string

id

required

string

lastName

string

name

required

string

outstandingAmount

required

number

outstandingAmountMonthlyAverage

required

number

outstandingInvoicesCount

required

number

revenue

number

object (CurrencyDto)

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

grossProfitMargin

number

invoicesOutstanding

number

object (CurrencyDto)

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

numberOfCustomers

number

paymentTerms

number

primaryBank

number

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (TradingHistoryDto)

Array

debtorsInvoicesDue	number
debtorsOutstanding	number
dividends	number
fixedAssets	number
netAssets	number
profitNet required	number
revenue required	number
year	number
yearEnd required	number

Array of objects (MerchantCashAdvanceDataDto)

Array

averageMonthlyTransactions	number
monthsOnBusinessLease	number
terminalId	string
type	string Enum: "Amazon" "Deliveroo" "Ebay" "Etsy" "Ingenico" "Izettle" "Other" "PB payment solutions" "Paylevel" "Paypal here" "Shopify" "SmartTrade" "Sumsup" "Transax" "Uber" "Verifone" "Worldpay"

Array of objects (PropertyDataDto)

Array

additionalDetails

string

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

classification

string

Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"

required

object (CurrencyDto)

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

location

string

Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"

required

object (CurrencyDto)

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

setting

string

Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"

type

string

Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"

required

object (CurrencyDto)

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

Array of objects (TradeReferenceDto)

Array

companyName required	string
contactEmail	string
contactName required	string
contactNumber required	string

updatedAt

required

string

Request samples

Payload

Content type

application/json

{"companyInformation": {"type": "LIMITED_COMPANY",
"sector": "AGRICULTURE",
"vatStatus": "NOT_REGISTERED",
"name": "string",
"registrationNumber": "string",
"score": {"grade": "A",
"industryAverageGrade": "A",
"value": 0,
"changedAt": "string",
"lastAssessedAt": "string",
"previous": {"grade": "A"
}
},
"creditLimit": {"code": "EUR",
"value": 0
},
"unencumberedAssets": {"guarantees": "BUSINESS",
"isHomeOwnership": true,
"personalGuarantee": true,
"businessOwnsAssets": true
},
"isGovernmentBacked": true,
"hasGovernmentBackedLoans": true,
"employeesNumber": 0,
"percentageSalesOnline": 0,
"website": "string",
"legalNotices": {"company": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
},
"directors": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
}
},
"primaryContactInformation": {"email": "string",
"name": "string",
"number": "string",
"inviteClient": true,
"legalRequirements": true,
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"tradingAddress": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"financials": {"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"bankInterest": {"code": "EUR",
"value": 0
},
"depreciation": {"code": "EUR",
"value": 0
},
"amortisation": {"code": "EUR",
"value": 0
},
"tradingHistory": [{"debtorsInvoicesDue": 0,
"debtorsOutstanding": 0,
"fixedAssets": 0,
"netAssets": 0,
"profitNet": 0,
"dividends": 0,
"revenue": 0,
"year": 0,
"yearEnd": 0
}
],
"debtors": [{"id": "string",
"contactId": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"emailAddress": "string",
"outstandingAmount": 0,
"outstandingAmountMonthlyAverage": 0,
"outstandingInvoicesCount": 0,
"contactNumber": "string",
"debtorDays": 0,
"revenue": 0,
"averageMonthlyIncome": {"code": "EUR",
"value": 0
},
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
}
],
"primaryBank": 0,
"tradeDebtors": {"code": "EUR",
"value": 0
},
"paymentTerms": 0,
"invoicesOutstanding": 0,
"numberOfCustomers": 0,
"currentValueConfirmedOrders": {"code": "EUR",
"value": 0
},
"grossProfitMargin": 0
},
"properties": [{"type": "FLATS",
"location": "EUROPE",
"setting": "CITY",
"classification": "COMMERCIAL",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"outstandingDebt": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"additionalDetails": "string"
}
],
"assets": [{"type": "BUSINESS",
"name": "string",
"offeredAsGuarantee": true,
"netCost": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"existingAgreement": true
}
],
"assetsForSecurity": [{"type": "MAIN_PROPERTY",
"owner": "string",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"totalDebt": {"code": "EUR",
"value": 0
}
}
],
"merchantCashAdvance": [{"type": "Amazon",
"averageMonthlyTransactions": 0,
"terminalId": "string",
"monthsOnBusinessLease": 0
}
],
"tradeReferences": [{"companyName": "string",
"contactName": "string",
"contactNumber": "string",
"contactEmail": "string"
}
]
}

Response samples

201

Content type

application/json

{"companyInformation": {"type": "LIMITED_COMPANY",
"sector": "AGRICULTURE",
"vatStatus": "NOT_REGISTERED",
"name": "string",
"registrationNumber": "string",
"score": {"grade": "A",
"industryAverageGrade": "A",
"value": 0,
"changedAt": "string",
"lastAssessedAt": "string",
"previous": {"grade": "A"
}
},
"creditLimit": {"code": "EUR",
"value": 0
},
"unencumberedAssets": {"guarantees": "BUSINESS",
"isHomeOwnership": true,
"personalGuarantee": true,
"businessOwnsAssets": true
},
"isGovernmentBacked": true,
"hasGovernmentBackedLoans": true,
"employeesNumber": 0,
"percentageSalesOnline": 0,
"website": "string",
"legalNotices": {"company": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
},
"directors": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
}
},
"primaryContactInformation": {"email": "string",
"name": "string",
"number": "string",
"inviteClient": true,
"legalRequirements": true,
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"tradingAddress": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"financials": {"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"bankInterest": {"code": "EUR",
"value": 0
},
"depreciation": {"code": "EUR",
"value": 0
},
"amortisation": {"code": "EUR",
"value": 0
},
"tradingHistory": [{"debtorsInvoicesDue": 0,
"debtorsOutstanding": 0,
"fixedAssets": 0,
"netAssets": 0,
"profitNet": 0,
"dividends": 0,
"revenue": 0,
"year": 0,
"yearEnd": 0
}
],
"debtors": [{"id": "string",
"contactId": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"emailAddress": "string",
"outstandingAmount": 0,
"outstandingAmountMonthlyAverage": 0,
"outstandingInvoicesCount": 0,
"contactNumber": "string",
"debtorDays": 0,
"revenue": 0,
"averageMonthlyIncome": {"code": "EUR",
"value": 0
},
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
}
],
"primaryBank": 0,
"tradeDebtors": {"code": "EUR",
"value": 0
},
"paymentTerms": 0,
"invoicesOutstanding": 0,
"numberOfCustomers": 0,
"currentValueConfirmedOrders": {"code": "EUR",
"value": 0
},
"grossProfitMargin": 0
},
"properties": [{"type": "FLATS",
"location": "EUROPE",
"setting": "CITY",
"classification": "COMMERCIAL",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"outstandingDebt": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"additionalDetails": "string"
}
],
"assets": [{"type": "BUSINESS",
"name": "string",
"offeredAsGuarantee": true,
"netCost": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"existingAgreement": true
}
],
"assetsForSecurity": [{"type": "MAIN_PROPERTY",
"owner": "string",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"totalDebt": {"code": "EUR",
"value": 0
}
}
],
"merchantCashAdvance": [{"type": "Amazon",
"averageMonthlyTransactions": 0,
"terminalId": "string",
"monthsOnBusinessLease": 0
}
],
"tradeReferences": [{"companyName": "string",
"contactName": "string",
"contactNumber": "string",
"contactEmail": "string"
}
],
"createdAt": "string",
"updatedAt": "string"
}

Update 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

Array of objects (AssetDataDto)

Array

object (CurrencyDto)

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

existingAgreement

boolean

name

string

required

object (CurrencyDto)

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

offeredAsGuarantee

boolean

type

required

string

Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "PROPERTY" "STOCK" "TRANSPORTATION"

Array of objects (AssetSecurityDataDto)

Array

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

owner

required

string

object (CurrencyDto)

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

type

required

string

Enum: "MAIN_PROPERTY" "OTHER_FIXED_ASSETS" "OTHER_PROPERTY"

object (CurrencyDto)

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

required

object (CompanyInformationDto)

object (CurrencyDto)

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

employeesNumber

number

hasGovernmentBackedLoans

boolean

isGovernmentBacked

boolean

object (LegalNoticesDto)

object (CompanyLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

object (DirectorsLegalNoticesDto)

last12MonthsCount

number

object (CurrencyDto)

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

name

string

percentageSalesOnline

number

object (PrimaryContactInformationDto)

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

email

required

string

inviteClient

boolean

legalRequirements

boolean

name

required

string

number

required

string

registrationNumber

required

string

object (CompanyScoreDto)

changedAt

string

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

industryAverageGrade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

lastAssessedAt

string

object (PreviousCompanyScoreDto)

grade

string

Enum: "A" "B" "C" "D" "E" "F" "G" "H"

value

number

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"

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

type

string

Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP"

object (UnencumberedAssetsDto)

businessOwnsAssets	boolean
guarantees	string Enum: "BUSINESS" "PERSONAL"
isHomeOwnership	boolean
personalGuarantee	boolean

vatStatus

string

Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN"

website

string

object (FinancialsDto)

object (CurrencyDto)

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

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (DebtorDto)

Array

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

object (CurrencyDto)

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

companyName

string

contactId

required

string

contactNumber

string

debtorDays

number

emailAddress

required

string

firstName

required

string

id

required

string

lastName

string

name

required

string

outstandingAmount

required

number

outstandingAmountMonthlyAverage

required

number

outstandingInvoicesCount

required

number

revenue

number

object (CurrencyDto)

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

grossProfitMargin

number

invoicesOutstanding

number

object (CurrencyDto)

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

numberOfCustomers

number

paymentTerms

number

primaryBank

number

object (CurrencyDto)

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

object (CurrencyDto)

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

Array of objects (TradingHistoryDto)

Array

debtorsInvoicesDue	number
debtorsOutstanding	number
dividends	number
fixedAssets	number
netAssets	number
profitNet required	number
revenue required	number
year	number
yearEnd required	number

Array of objects (MerchantCashAdvanceDataDto)

Array

averageMonthlyTransactions	number
monthsOnBusinessLease	number
terminalId	string
type	string Enum: "Amazon" "Deliveroo" "Ebay" "Etsy" "Ingenico" "Izettle" "Other" "PB payment solutions" "Paylevel" "Paypal here" "Shopify" "SmartTrade" "Sumsup" "Transax" "Uber" "Verifone" "Worldpay"

Array of objects (PropertyDataDto)

Array

additionalDetails

string

required

object (ProfileAddressDto)

city	string
houseNumber	string
postalCode	string
province	string
simpleValue	string
street	string

classification

string

Enum: "COMMERCIAL" "MIXED_USE" "RESIDENTIAL"

required

object (CurrencyDto)

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

location

string

Enum: "EUROPE" "NORTHERN_IRELAND" "OTHER" "SCOTTISH_ISLES" "SCOTTISH_MAINLAND" "UK_ISLES" "UK_MAINLAND"

required

object (CurrencyDto)

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

setting

string

Enum: "CITY" "INDUSTRIAL" "RURAL" "TOWN"

type

string

Enum: "FLATS" "HMO" "HOLIDAY_LETS" "HOTEL" "LEISURE_FACILITY" "OFFICES" "OTHER" "RESIDENTIAL_HOUSING" "RETAIL" "STUDENT_HOUSING"

required

object (CurrencyDto)

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

Array of objects (TradeReferenceDto)

Array

companyName required	string
contactEmail	string
contactName required	string
contactNumber required	string

Responses

Request samples

Payload

Content type

application/json

{"companyInformation": {"type": "LIMITED_COMPANY",
"sector": "AGRICULTURE",
"vatStatus": "NOT_REGISTERED",
"name": "string",
"registrationNumber": "string",
"score": {"grade": "A",
"industryAverageGrade": "A",
"value": 0,
"changedAt": "string",
"lastAssessedAt": "string",
"previous": {"grade": "A"
}
},
"creditLimit": {"code": "EUR",
"value": 0
},
"unencumberedAssets": {"guarantees": "BUSINESS",
"isHomeOwnership": true,
"personalGuarantee": true,
"businessOwnsAssets": true
},
"isGovernmentBacked": true,
"hasGovernmentBackedLoans": true,
"employeesNumber": 0,
"percentageSalesOnline": 0,
"website": "string",
"legalNotices": {"company": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
},
"directors": {"last12MonthsCount": 0,
"last12MonthsValue": {"code": "EUR",
"value": 0
}
}
},
"primaryContactInformation": {"email": "string",
"name": "string",
"number": "string",
"inviteClient": true,
"legalRequirements": true,
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"tradingAddress": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
},
"financials": {"netProfit": {"code": "EUR",
"value": 0
},
"revenue": {"code": "EUR",
"value": 0
},
"bankInterest": {"code": "EUR",
"value": 0
},
"depreciation": {"code": "EUR",
"value": 0
},
"amortisation": {"code": "EUR",
"value": 0
},
"tradingHistory": [{"debtorsInvoicesDue": 0,
"debtorsOutstanding": 0,
"fixedAssets": 0,
"netAssets": 0,
"profitNet": 0,
"dividends": 0,
"revenue": 0,
"year": 0,
"yearEnd": 0
}
],
"debtors": [{"id": "string",
"contactId": "string",
"name": "string",
"firstName": "string",
"lastName": "string",
"companyName": "string",
"emailAddress": "string",
"outstandingAmount": 0,
"outstandingAmountMonthlyAverage": 0,
"outstandingInvoicesCount": 0,
"contactNumber": "string",
"debtorDays": 0,
"revenue": 0,
"averageMonthlyIncome": {"code": "EUR",
"value": 0
},
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
}
}
],
"primaryBank": 0,
"tradeDebtors": {"code": "EUR",
"value": 0
},
"paymentTerms": 0,
"invoicesOutstanding": 0,
"numberOfCustomers": 0,
"currentValueConfirmedOrders": {"code": "EUR",
"value": 0
},
"grossProfitMargin": 0
},
"properties": [{"type": "FLATS",
"location": "EUROPE",
"setting": "CITY",
"classification": "COMMERCIAL",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"outstandingDebt": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"additionalDetails": "string"
}
],
"assets": [{"type": "BUSINESS",
"name": "string",
"offeredAsGuarantee": true,
"netCost": {"code": "EUR",
"value": 0
},
"depositAvailable": {"code": "EUR",
"value": 0
},
"existingAgreement": true
}
],
"assetsForSecurity": [{"type": "MAIN_PROPERTY",
"owner": "string",
"address": {"simpleValue": "string",
"street": "string",
"houseNumber": "string",
"city": "string",
"province": "string",
"postalCode": "string"
},
"value": {"code": "EUR",
"value": 0
},
"totalDebt": {"code": "EUR",
"value": 0
}
}
],
"merchantCashAdvance": [{"type": "Amazon",
"averageMonthlyTransactions": 0,
"terminalId": "string",
"monthsOnBusinessLease": 0
}
],
"tradeReferences": [{"companyName": "string",
"contactName": "string",
"contactNumber": "string",
"contactEmail": "string"
}
]
}