Marketplace (1.0.0)
Download OpenAPI specification:Download
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.
Refresh marketplace access token.
This endpoint allows you to get a refresh access token from a refresh token.
Authorizations:
Request Body schema: application/json
refreshToken required | string |
Responses
Request samples
- Payload
{- "refreshToken": "161c04f04289f442f8b9b91fdd39c554597639876e9bda4d16bed31a787b5c5d"
}
Response samples
- 200
{- "refreshToken": "161c04f04289f442f8b9b91fdd39c554597639876e9bda4d16bed31a787b5c5d",
- "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkNhcGl0YWxpc2UgQVBJIE1ha2V0cGxhY2UiLCJpYXQiOjE1MTYyMzkwMjJ9.6MDnQOI3PM6Srg0qpWtefAjNOkAhminw1xokO-03Tzs"
}
Create a non-funding case.
This endpoint allows you to apply a profile into a non-funding case (ex: Recovery, Grants, Credit Improvement).
Authorizations:
path Parameters
uuid required | string Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile UUID. |
Responses
Response samples
- 200
{- "id": "string",
- "profile": "string",
- "businessId": 0,
- "type": "string",
- "private": true,
- "offersAwaitingReview": true,
- "followers": [
- "string"
], - "product": "string",
- "products": [
- "string"
], - "productName": "string",
- "productNames": [
- "string"
], - "caseState": "string",
- "caseStateName": "string",
- "state": "string",
- "stateName": "string",
- "stateType": "string",
- "stateUpdatedAt": "2019-08-24T14:15:22Z",
- "details": {
- "title": "string",
- "description": "string",
- "amount": { }
}, - "owner": {
- "id": 0,
- "name": "string",
- "email": "string",
- "team": 0
}, - "manager": {
- "id": 0
}, - "latestActivity": {
- "id": "string",
- "title": "string",
- "createdAt": "2019-08-24T14:15:22Z"
}, - "integration": {
- "name": "string",
- "generatedAt": "2019-08-24T14:15:22Z"
}
}
Get company data by registration number.
Get companies data by registration number.
Authorizations:
path Parameters
registrationNumber required | string Example: 09256446 Company registration number |
query Parameters
countryCode | string Example: countryCode=GB Country code. |
Responses
Response samples
- 200
{- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}
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:
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 samples
- 200
[- {
- "name": "string",
- "number": "string"
}
]
Get funding matches.
Retrieves all the available funding matches currently matched with the given profile.
Authorizations:
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 samples
- 200
{- "amount": 150000,
- "matches": [
- {
- "lender": {
- "id": 1
}, - "product": "TERM_LOAN"
}
]
}
Get the amount of matched lenders.
Get the total amount of matched lenders for the given profile.
Authorizations:
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 samples
- 200
4
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:
path Parameters
uuid required | string Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile UUID. |
Request Body schema: application/json
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
Request samples
- Payload
[- {
- "lenderId": 1,
- "products": [
- "TERM_LOAN"
]
}
]
Response samples
- 200
{- "amount": 150000,
- "matches": [
- {
- "lender": {
- "id": 1
}, - "product": "TERM_LOAN"
}
]
}
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:
path Parameters
uuid required | string Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile UUID. |
type required | string Value: "funding-search" Type of url. |
query Parameters
redirect | boolean Default: false Redirect option |
Responses
Response samples
- 200
/profiles/anonymous
This endpoint generates a new blank anonymous profile which can be used to store data submitted through questionnaires.
Authorizations:
Request Body schema: application/json
countryCode | string Enum: "GB" "ZA" |
Responses
Request samples
- Payload
{- "countryCode": "GB"
}
Response samples
- 200
{- "companyInformation": {
- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}, - "financials": {
- "revenue": {
- "code": "GBP",
- "value": 100000
}
}, - "persons": [
- {
- "type": "string",
- "title": "string",
- "name": "string",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "dateOfBirth": "2019-08-24T14:15:22Z"
}
], - "properties": [
- {
- "type": "FLATS",
- "location": "EUROPE",
- "setting": "CITY",
- "classification": "COMMERCIAL",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "value": {
- "code": "GBP",
- "value": 150000
}, - "outstandingDebt": {
- "code": "GBP",
- "value": 150000
}, - "depositAvailable": {
- "code": "GBP",
- "value": 150000
}, - "additionalDetails": "string"
}
], - "assets": [
- {
- "name": "string",
- "offeredAsGuarantee": true,
- "type": "BUSINESS",
- "netCost": {
- "code": "GBP",
- "value": 150000
}, - "depositAvailable": {
- "code": "GBP",
- "value": 150000
}, - "existingAgreement": true
}
], - "assetsForSecurity": [
- {
- "type": "MAIN_PROPERTY",
- "owner": "string",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "value": {
- "code": "GBP",
- "value": 150000
}, - "totalDebt": {
- "code": "GBP",
- "value": 150000
}
}
], - "merchantCashAdvance": [
- {
- "averageMonthlyTransactions": 0
}
], - "uuid": "string",
- "eligibilityRequest": {
- "sourceQuestionnaireId": "string",
- "shared": {
- "fundingUrgency": "string",
- "useOfFunds": "string",
- "fundingAmount": {
- "code": "GBP",
- "value": 150000
}, - "fundingPeriod": 0,
- "previousLoanApplication": true,
- "previousLoanDeclined": true,
- "tradingImpacted": true,
- "declaredForBusinessPurposes": true,
- "backgroundPurpose": "string"
}, - "recovery": {
- "defendant": {
- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}, - "claimAmount": {
- "code": "GBP",
- "value": 150000
}
}, - "innovationRequirements": {
- "tradingDifficulty": true,
- "grants": {
- "uniqueIp": true,
- "previousGrantApplication": true
}, - "rdTaxClaim": {
- "isInnovating": true,
- "hasTaxRelief": true
}
}, - "commercialProperty": {
- "refinancing": true,
- "portfolioSize": "string",
- "repaymentMethod": "string",
- "annualIncome": {
- "code": "GBP",
- "value": 150000
}, - "productPropertyType": "string",
- "depositOrEquity": {
- "code": "GBP",
- "value": 150000
}, - "outstandingDebt": {
- "code": "GBP",
- "value": 150000
}
}, - "termLoan": {
- "hasTermLoan": true,
- "preferredCreditFacility": [
- "string"
]
}, - "invoiceFinance": {
- "raisesInvoices": true,
- "customerType": 0
}, - "merchantCash": {
- "acceptsCommercePayments": true
}, - "assetFinance": {
- "ownsAssets": true
}, - "tradeFinance": {
- "hasPurchaseOrders": true
}, - "requestedProducts": [
- "string"
], - "appliedProducts": [
- "string"
]
}, - "legacy": {
- "entityBusinessId": 0,
- "fundingSearchId": 0
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
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:
Responses
Response samples
- 200
{- "companyInformation": {
- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}, - "financials": {
- "revenue": {
- "code": "GBP",
- "value": 100000
}
}, - "persons": [
- {
- "type": "string",
- "title": "string",
- "name": "string",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "dateOfBirth": "2019-08-24T14:15:22Z"
}
], - "properties": [
- {
- "type": "FLATS",
- "location": "EUROPE",
- "setting": "CITY",
- "classification": "COMMERCIAL",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "value": {
- "code": "GBP",
- "value": 150000
}, - "outstandingDebt": {
- "code": "GBP",
- "value": 150000
}, - "depositAvailable": {
- "code": "GBP",
- "value": 150000
}, - "additionalDetails": "string"
}
], - "assets": [
- {
- "name": "string",
- "offeredAsGuarantee": true,
- "type": "BUSINESS",
- "netCost": {
- "code": "GBP",
- "value": 150000
}, - "depositAvailable": {
- "code": "GBP",
- "value": 150000
}, - "existingAgreement": true
}
], - "assetsForSecurity": [
- {
- "type": "MAIN_PROPERTY",
- "owner": "string",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "value": {
- "code": "GBP",
- "value": 150000
}, - "totalDebt": {
- "code": "GBP",
- "value": 150000
}
}
], - "merchantCashAdvance": [
- {
- "averageMonthlyTransactions": 0
}
], - "uuid": "string",
- "eligibilityRequest": {
- "sourceQuestionnaireId": "string",
- "shared": {
- "fundingUrgency": "string",
- "useOfFunds": "string",
- "fundingAmount": {
- "code": "GBP",
- "value": 150000
}, - "fundingPeriod": 0,
- "previousLoanApplication": true,
- "previousLoanDeclined": true,
- "tradingImpacted": true,
- "declaredForBusinessPurposes": true,
- "backgroundPurpose": "string"
}, - "recovery": {
- "defendant": {
- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}, - "claimAmount": {
- "code": "GBP",
- "value": 150000
}
}, - "innovationRequirements": {
- "tradingDifficulty": true,
- "grants": {
- "uniqueIp": true,
- "previousGrantApplication": true
}, - "rdTaxClaim": {
- "isInnovating": true,
- "hasTaxRelief": true
}
}, - "commercialProperty": {
- "refinancing": true,
- "portfolioSize": "string",
- "repaymentMethod": "string",
- "annualIncome": {
- "code": "GBP",
- "value": 150000
}, - "productPropertyType": "string",
- "depositOrEquity": {
- "code": "GBP",
- "value": 150000
}, - "outstandingDebt": {
- "code": "GBP",
- "value": 150000
}
}, - "termLoan": {
- "hasTermLoan": true,
- "preferredCreditFacility": [
- "string"
]
}, - "invoiceFinance": {
- "raisesInvoices": true,
- "customerType": 0
}, - "merchantCash": {
- "acceptsCommercePayments": true
}, - "assetFinance": {
- "ownsAssets": true
}, - "tradeFinance": {
- "hasPurchaseOrders": true
}, - "requestedProducts": [
- "string"
], - "appliedProducts": [
- "string"
]
}, - "legacy": {
- "entityBusinessId": 0,
- "fundingSearchId": 0
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Get profile.
This endpoint allows you to retrieve your full profile object.
Authorizations:
path Parameters
uuid required | string Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile UUID. |
Responses
Response samples
- 200
{- "companyInformation": {
- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}, - "financials": {
- "revenue": {
- "code": "GBP",
- "value": 100000
}
}, - "persons": [
- {
- "type": "string",
- "title": "string",
- "name": "string",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "dateOfBirth": "2019-08-24T14:15:22Z"
}
], - "properties": [
- {
- "type": "FLATS",
- "location": "EUROPE",
- "setting": "CITY",
- "classification": "COMMERCIAL",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "value": {
- "code": "GBP",
- "value": 150000
}, - "outstandingDebt": {
- "code": "GBP",
- "value": 150000
}, - "depositAvailable": {
- "code": "GBP",
- "value": 150000
}, - "additionalDetails": "string"
}
], - "assets": [
- {
- "name": "string",
- "offeredAsGuarantee": true,
- "type": "BUSINESS",
- "netCost": {
- "code": "GBP",
- "value": 150000
}, - "depositAvailable": {
- "code": "GBP",
- "value": 150000
}, - "existingAgreement": true
}
], - "assetsForSecurity": [
- {
- "type": "MAIN_PROPERTY",
- "owner": "string",
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "value": {
- "code": "GBP",
- "value": 150000
}, - "totalDebt": {
- "code": "GBP",
- "value": 150000
}
}
], - "merchantCashAdvance": [
- {
- "averageMonthlyTransactions": 0
}
], - "uuid": "string",
- "eligibilityRequest": {
- "sourceQuestionnaireId": "string",
- "shared": {
- "fundingUrgency": "string",
- "useOfFunds": "string",
- "fundingAmount": {
- "code": "GBP",
- "value": 150000
}, - "fundingPeriod": 0,
- "previousLoanApplication": true,
- "previousLoanDeclined": true,
- "tradingImpacted": true,
- "declaredForBusinessPurposes": true,
- "backgroundPurpose": "string"
}, - "recovery": {
- "defendant": {
- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}, - "claimAmount": {
- "code": "GBP",
- "value": 150000
}
}, - "innovationRequirements": {
- "tradingDifficulty": true,
- "grants": {
- "uniqueIp": true,
- "previousGrantApplication": true
}, - "rdTaxClaim": {
- "isInnovating": true,
- "hasTaxRelief": true
}
}, - "commercialProperty": {
- "refinancing": true,
- "portfolioSize": "string",
- "repaymentMethod": "string",
- "annualIncome": {
- "code": "GBP",
- "value": 150000
}, - "productPropertyType": "string",
- "depositOrEquity": {
- "code": "GBP",
- "value": 150000
}, - "outstandingDebt": {
- "code": "GBP",
- "value": 150000
}
}, - "termLoan": {
- "hasTermLoan": true,
- "preferredCreditFacility": [
- "string"
]
}, - "invoiceFinance": {
- "raisesInvoices": true,
- "customerType": 0
}, - "merchantCash": {
- "acceptsCommercePayments": true
}, - "assetFinance": {
- "ownsAssets": true
}, - "tradeFinance": {
- "hasPurchaseOrders": true
}, - "requestedProducts": [
- "string"
], - "appliedProducts": [
- "string"
]
}, - "legacy": {
- "entityBusinessId": 0,
- "fundingSearchId": 0
}, - "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
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:
path Parameters
uuid required | string Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile UUID. |
targetApiKey required | string The target API key to move the profile to. |
Responses
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:
path Parameters
uuid required | string Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile UUID. |
Request Body schema: application/json
non-emptyname | string (Company name) |
type | string (Company type) Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP" |
registrationNumber | string (Company Number) |
incorporatedAt | string <date-time> (Incorporation date) |
tradingFromDate | string <date-time> (Trading from date) |
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" |
vatStatus | string (VAT status) Enum: "NOT_REGISTERED" "REGISTERED" "UNKNOWN" |
object (CompanyScoreDto) The credit score and band of the company | |
object (AnswerCurrencyDto) (tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined }) | |
object (AddressDto) (tsType: AddressDto, schemaOptions: { exclude: undefined }) | |
object (PrimaryContactInformationDto) (tsType: PrimaryContactInformationDto, schemaOptions: { exclude: undefined }) | |
object (UnencumberedAssetsDto) (tsType: UnencumberedAssetsDto, schemaOptions: { exclude: undefined }) | |
isGovernmentBacked | boolean |
hasGovernmentBackedLoans | boolean |
employeesNumber | number (No. of employees) |
percentageSalesOnline | number (% of sales online) |
website | string |
Responses
Request samples
- Payload
{- "name": "string",
- "type": "LIMITED_COMPANY",
- "registrationNumber": "string",
- "incorporatedAt": "2019-08-24T14:15:22Z",
- "tradingFromDate": "2019-08-24T14:15:22Z",
- "sector": "AGRICULTURE",
- "vatStatus": "NOT_REGISTERED",
- "score": {
- "grade": "A",
- "value": 100
}, - "creditLimit": {
- "code": "GBP",
- "value": 150000
}, - "contactAddress": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}, - "primaryContactInformation": {
- "email": "string",
- "name": "string",
- "number": "string",
- "inviteClient": true,
- "legalRequirements": true,
- "address": {
- "simpleValue": "string",
- "street": "string",
- "houseNumber": "string",
- "city": "string",
- "province": "string",
- "postalCode": "string"
}
}, - "unencumberedAssets": {
- "guarantees": "BOTH",
- "isHomeOwnership": true,
- "personalGuarantee": true,
- "businessOwnsAssets": true
}, - "isGovernmentBacked": true,
- "hasGovernmentBackedLoans": true,
- "employeesNumber": 0,
- "percentageSalesOnline": 0,
- "website": "string"
}
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:
path Parameters
uuid required | string Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile UUID. |
Request Body schema: application/json
non-emptyobject (AnswerCurrencyDto) (tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined }) | |
object (AnswerCurrencyDto) (tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined }) | |
object (AnswerCurrencyDto) (tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined }) | |
object (AnswerCurrencyDto) (tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined }) | |
object (AnswerCurrencyDto) (tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined }) | |
object (AnswerCurrencyDto) (tsType: AnswerCurrencyDto, schemaOptions: { exclude: undefined }) | |
Array of objects (TradingHistoryDto) | |
Array of objects (DebtorDto) | |
primaryBank | number |
Responses
Request samples
- Payload
{- "revenue": {
- "code": "GBP",
- "value": 100000
}
}
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:
path Parameters
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 |
profileId required | string <uuid> Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile 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:
path Parameters
id required | string Example: introducer-working-capital Questionnaire ID. |
Responses
Response samples
- 200
{- "id": "string",
- "title": "string",
- "questions": { }
}
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:
path Parameters
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 |
profileId required | string <uuid> Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile ID |
Request Body schema: application/json
clientName required | string What is the full name of the applicant? |
clientEmail required | string <email> What is your e-mail to contact the applicant? |
clientNumber required | string^\+?[0-9\s]{11,30}$ What is the contact number of the applicant? E.g. +449328291829 |
inviteClient | boolean Default: false Automatically invite the client to the view and track application at Capitalise.com? Highly recommend to set it as |
companyType required | string Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP" What is your type of business? |
companyNumber | string non-empty What is the registered company number? Required when |
companyName required | string non-empty What is the name of the company? |
businessPurposes | boolean Default: null Required when |
fundingUrgency | string Enum: "ASAP" "JUST_BROWSING" "ONE_MONTH" "ONE_WEEK" "REFINANCING" How soon does the business need the funding? |
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" What will the funds be used for? |
required | object How much funding the business is searching for? |
fundingPeriod required | number >= 0 Enum: 12 24 36 48 6 60 How long (in months) does the business need the funding?
|
personalGuarantee | boolean Default: false Director(s) of the business can offer a limited personal guarantee... Most lenders will require directors to offer this. |
homeOwnership | boolean Default: false Is any of the directors UK homeowner? |
businessOwnsAssets | boolean Default: false Does the business own assets or property? |
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? |
tradingAddress | string non-empty What is the business trading address? Format :Street, no, postcode |
incorporationDate required | string <date> When did the business start trading? |
object What is the business last reported annual net profit? | |
object What are the business current trade debtors? | |
required | object non-empty What is the business last reported annual revenue? |
object non-empty What is the business last reported annual bank interest? | |
object non-empty What is the business last reported annual depreciation? | |
object non-empty What is the business last reported annual amortisation? | |
raiseInvoices required | boolean Default: false Does The business raise invoices to clients? Invoices should have payment terms of 14 days or more. |
cardPayments required | boolean Default: false Does the business accept card payments? Credit/Debit card terminal, online payments or any other e-commerce payments. |
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
|
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. |
assetType | string Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "STOCK" "TRANSPORTATION" What kind of asset is it? Let us know the category of asset. Required only when |
assetExistingAgreement | boolean Default: false Is there an existing agreement for this asset? Optional to fill in when |
purchaseOrders required | boolean Default: false Does the business receive purchase orders? Or if your company imports good from outside the UK. |
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. |
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. |
Responses
Request samples
- Payload
{- "clientName": "string",
- "clientEmail": "user@example.com",
- "clientNumber": "string",
- "inviteClient": false,
- "companyType": "LIMITED_COMPANY",
- "companyNumber": "string",
- "companyName": "string",
- "businessPurposes": null,
- "fundingUrgency": "ASAP",
- "useOfFunds": "CASH_FLOW",
- "fundingAmount": {
- "code": "GBP",
- "value": 25000
}, - "fundingPeriod": 12,
- "personalGuarantee": false,
- "homeOwnership": false,
- "businessOwnsAssets": false,
- "sector": "AGRICULTURE",
- "tradingAddress": "Number, Street, Postcode",
- "incorporationDate": "2019-08-24",
- "netProfit": {
- "code": "GBP",
- "value": 0
}, - "tradeDebtors": {
- "code": "GBP",
- "value": 0
}, - "revenue": {
- "code": "GBP",
- "value": 0
}, - "bankInterest": {
- "code": "GBP",
- "value": 0
}, - "depreciation": {
- "code": "GBP",
- "value": 0
}, - "amortisation": {
- "code": "GBP",
- "value": 0
}, - "raiseInvoices": false,
- "cardPayments": false,
- "averageCardSales": 15000,
- "fundingAsset": false,
- "assetType": "BUSINESS",
- "assetExistingAgreement": false,
- "purchaseOrders": false,
- "governmentBacked": false,
- "governmentBackedLoansExist": false,
- "legalRequirements": true
}
Delete questionnaire answers.
This endpoint allows you to delete profile questionnaire answers by UUID.
Authorizations:
path Parameters
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 |
profileId required | string <uuid> Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile ID |
query Parameters
answerKey | Array of strings |
Responses
Get questionnaire answers.
This endpoint allows you to get the questionnaire answers you have submitted by UUID.
Authorizations:
path Parameters
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 |
profileId required | string <uuid> Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile ID |
Responses
Response samples
- 200
{- "clientName": "string",
- "clientEmail": "user@example.com",
- "clientNumber": "string",
- "inviteClient": false,
- "companyType": "LIMITED_COMPANY",
- "companyNumber": "string",
- "companyName": "string",
- "businessPurposes": null,
- "fundingUrgency": "ASAP",
- "useOfFunds": "CASH_FLOW",
- "fundingAmount": {
- "code": "GBP",
- "value": 25000
}, - "fundingPeriod": 12,
- "personalGuarantee": false,
- "homeOwnership": false,
- "businessOwnsAssets": false,
- "sector": "AGRICULTURE",
- "tradingAddress": "Number, Street, Postcode",
- "incorporationDate": "2019-08-24",
- "netProfit": {
- "code": "GBP",
- "value": 0
}, - "tradeDebtors": {
- "code": "GBP",
- "value": 0
}, - "revenue": {
- "code": "GBP",
- "value": 0
}, - "bankInterest": {
- "code": "GBP",
- "value": 0
}, - "depreciation": {
- "code": "GBP",
- "value": 0
}, - "amortisation": {
- "code": "GBP",
- "value": 0
}, - "raiseInvoices": false,
- "cardPayments": false,
- "averageCardSales": 15000,
- "fundingAsset": false,
- "assetType": "BUSINESS",
- "assetExistingAgreement": false,
- "purchaseOrders": false,
- "governmentBacked": false,
- "governmentBackedLoansExist": false,
- "legalRequirements": true
}
Update a selection of questionnaire answers
This endpoint allows you to patch profile questionnaire answers by UUID.
Authorizations:
path Parameters
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 |
profileId required | string <uuid> Example: b1a9d07f-5546-461e-a8c4-7f41d977fd45 Profile ID |
Request Body schema: application/json
clientName required | string What is the full name of the applicant? |
clientEmail required | string <email> What is your e-mail to contact the applicant? |
clientNumber required | string^\+?[0-9\s]{11,30}$ What is the contact number of the applicant? E.g. +449328291829 |
inviteClient | boolean Default: false Automatically invite the client to the view and track application at Capitalise.com? Highly recommend to set it as |
companyType required | string Enum: "LIMITED_COMPANY" "LIMITED_LIABILITY_PARTNERSHIP" "SOLE_TRADER" "STARTUP" What is your type of business? |
companyNumber | string non-empty What is the registered company number? Required when |
companyName required | string non-empty What is the name of the company? |
businessPurposes | boolean Default: null Required when |
fundingUrgency | string Enum: "ASAP" "JUST_BROWSING" "ONE_MONTH" "ONE_WEEK" "REFINANCING" How soon does the business need the funding? |
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" What will the funds be used for? |
required | object How much funding the business is searching for? |
fundingPeriod required | number >= 0 Enum: 12 24 36 48 6 60 How long (in months) does the business need the funding?
|
personalGuarantee | boolean Default: false Director(s) of the business can offer a limited personal guarantee... Most lenders will require directors to offer this. |
homeOwnership | boolean Default: false Is any of the directors UK homeowner? |
businessOwnsAssets | boolean Default: false Does the business own assets or property? |
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? |
tradingAddress | string non-empty What is the business trading address? Format :Street, no, postcode |
incorporationDate required | string <date> When did the business start trading? |
object What is the business last reported annual net profit? | |
object What are the business current trade debtors? | |
required | object non-empty What is the business last reported annual revenue? |
object non-empty What is the business last reported annual bank interest? | |
object non-empty What is the business last reported annual depreciation? | |
object non-empty What is the business last reported annual amortisation? | |
raiseInvoices required | boolean Default: false Does The business raise invoices to clients? Invoices should have payment terms of 14 days or more. |
cardPayments required | boolean Default: false Does the business accept card payments? Credit/Debit card terminal, online payments or any other e-commerce payments. |
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
|
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. |
assetType | string Enum: "BUSINESS" "MANUFACTURING" "OFFICE" "STOCK" "TRANSPORTATION" What kind of asset is it? Let us know the category of asset. Required only when |
assetExistingAgreement | boolean Default: false Is there an existing agreement for this asset? Optional to fill in when |
purchaseOrders required | boolean Default: false Does the business receive purchase orders? Or if your company imports good from outside the UK. |
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. |
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. |
Responses
Request samples
- Payload
{- "clientName": "string",
- "clientEmail": "user@example.com",
- "clientNumber": "string",
- "inviteClient": false,
- "companyType": "LIMITED_COMPANY",
- "companyNumber": "string",
- "companyName": "string",
- "businessPurposes": null,
- "fundingUrgency": "ASAP",
- "useOfFunds": "CASH_FLOW",
- "fundingAmount": {
- "code": "GBP",
- "value": 25000
}, - "fundingPeriod": 12,
- "personalGuarantee": false,
- "homeOwnership": false,
- "businessOwnsAssets": false,
- "sector": "AGRICULTURE",
- "tradingAddress": "Number, Street, Postcode",
- "incorporationDate": "2019-08-24",
- "netProfit": {
- "code": "GBP",
- "value": 0
}, - "tradeDebtors": {
- "code": "GBP",
- "value": 0
}, - "revenue": {
- "code": "GBP",
- "value": 0
}, - "bankInterest": {
- "code": "GBP",
- "value": 0
}, - "depreciation": {
- "code": "GBP",
- "value": 0
}, - "amortisation": {
- "code": "GBP",
- "value": 0
}, - "raiseInvoices": false,
- "cardPayments": false,
- "averageCardSales": 15000,
- "fundingAsset": false,
- "assetType": "BUSINESS",
- "assetExistingAgreement": false,
- "purchaseOrders": false,
- "governmentBacked": false,
- "governmentBackedLoansExist": false,
- "legalRequirements": true
}