Skip to main content

Capitalise APIs Explorer (1.0.0)

Download OpenAPI specification:Download

Capitalise Public API

Auth

AuthorizationManager.exchangeAccessTokenForJwt

Get platform access token from a given authorization code

Authorizations:
bearerAuth
path Parameters
code
required
string

Responses

Response samples

Content type
application/json
{
  • "jwt": "string"
}

AuthorizationManager.signUp

Sign up user into platform

Authorizations:
bearerAuth
Request Body schema: application/json
type
required
string
Enum: "BUSINESS" "INTRODUCER" "LENDER"
firstName
required
string
lastName
required
string
email
required
string
password
required
string
phone
string
referredBy
string
terms
required
boolean
newsletter
boolean
countryCode
required
string
Enum: "GB" "ZA"

Responses

Request samples

Content type
application/json
{
  • "type": "BUSINESS",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "password": "string",
  • "phone": "string",
  • "referredBy": "string",
  • "terms": true,
  • "newsletter": true,
  • "countryCode": "GB"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "refresh_token_expires_in": 0,
  • "scope": "string",
  • "expires_in": 0,
  • "token_type": "string"
}

Generate an API Key

Generate an API Key

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

A name for the API key

partnerApiKey
string

The API key of the Capitalise partner

scopes
required
Array of strings
Items Enum: "funding:read" "funding:write" "insights:read" "offline_access" "profile:multiples" "profile:read" "profile:write" "questionnaire:read" "questionnaire:write" "scoring:read"
expiresAt
string <date-time>

The date your API key will expire. Empty value will generate a permanent token

Responses

Request samples

Content type
application/json
{
  • "name": "My first API key",
  • "partnerApiKey": "API_PARTNER_KEY",
  • "scopes": [
    ],
  • "expiresAt": "2021-11-24T18:03:28.241Z"
}

Response samples

Content type
application/json
{
  • "key": "string",
  • "partnerApiKey": "string"
}

Genereate platform tokens

Generate platform tokens required for Marketplace V1 & V2 access

Request Body schema: application/json
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh_token": "string",
  • "refresh_token_expires_in": 0,
  • "scope": "string",
  • "expires_in": 0,
  • "token_type": "string"
}

Invite user to authorize

Start authorization for a third party integration

Authorizations:
bearerAuth
Request Body schema: application/json
apiKey
required
string non-empty

The partner API key

callback
required
string non-empty

Callback to redirect to after partner client login succeeds

Responses

Request samples

Content type
application/json
{}

Sign in user into Capitalise

Sign in user into Capitalise

Authorizations:
bearerAuth
query Parameters
hash
string
Request Body schema: application/json
email
required
string

The user email to authenticate

password
required
string

The user password

Responses

Request samples

Content type
application/json
{
  • "email": "user@email.com",
  • "password": "p4S5w0rd"
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Sign up user into platform Deprecated

Please use "/v1/criteria/sign-up/{hash}" instead

Authorizations:
bearerAuth
query Parameters
hash
required
string
Request Body schema: application/json
name
string
email
string
password
string
companyName
string
userType
string
Enum: "business" "introducer" "lender"
phone
string
referredBy
string
terms
boolean
newsletter
boolean
companyNumber
string
introducerType
string
Enum: "ACCOUNTANT" "COMMERCIAL_BROKER" "PROFESSIONAL_ADVISER" "TRADE_ASSOCIATION"

Responses

Request samples

Content type
application/json
{
  • "name": "Name",
  • "email": "user@email.com",
  • "password": "p4S5w0rd",
  • "companyName": "Company Name",
  • "userType": "introducer",
  • "phone": "1234 123 123",
  • "referredBy": "Referred by someone",
  • "terms": true,
  • "newsletter": true,
  • "companyNumber": "123123312",
  • "introducerType": "ACCOUNTANT"
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Sign up user into platform using a hash code

Sign up user into platform using a hash code

Authorizations:
bearerAuth
path Parameters
hash
required
string
Request Body schema: application/json
type
required
string
Enum: "BUSINESS" "INTRODUCER" "LENDER"
firstName
required
string
lastName
required
string
email
required
string
password
required
string
phone
string
referredBy
string
terms
required
boolean
newsletter
boolean
countryCode
required
string
Enum: "GB" "ZA"

Responses

Request samples

Content type
application/json
{
  • "type": "BUSINESS",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "password": "string",
  • "phone": "string",
  • "referredBy": "string",
  • "terms": true,
  • "newsletter": true,
  • "countryCode": "GB"
}

Response samples

Content type
application/json
{
  • "url": "string"
}

Start authorization for a third party integration Deprecated

Please use "/v1/authorize/callback-url" instead

Authorizations:
bearerAuth
Request Body schema: application/json
apiKey
required
string non-empty

The partner API key

callback
required
string non-empty

Callback to redirect to after partner client login succeeds

Responses

Request samples

Content type
application/json
{}