Skip to main content

Marketplace (beta) (2.0)

Download OpenAPI specification:Download

Overview

Marketplace V2 is redesigned to structure around tenant. Credit profile widget only supports Marketplace V2.

This suite of APIs is currently in beta. Please reach out to your Partnership Manager before migrate or using it.

Note: Marketplace V1 can be found here.

Environments

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

Authentication & Authorisation concepts

Throughout the Developer Portal where Marketplace V2 is mentioned, you will see below terminology:

  • API Key: this is a unique key of your application to access Capitalise APIs. It is generated by Platform V1
  • Master (access) token: this token is used to manage tenants at tenant level, e.g. /tenants. It can't be used to manage the product and data of a specific tenant.
  • Tenant (access) token: this token is used to manage the product and data of a specific tenants, e.g. /profile. It can't be used to manage tenants at tenant level.

Auth

Generate a master access token for tenants management

Authorizations:
X-API-Key
header Parameters
X-API-Key
required
string

API Key

Responses

Response samples

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

Generate a tenant access token

Generate a tenant access token to manage products and data of a specific tenant

Authorizations:
Master Access Token
header Parameters
Capitalise-tenant-id
string

The tenant ID

Responses

Response samples

Content type
application/json
{ }

Refresh a master access token

Authorizations:
Master Access Token
Request Body schema: application/json
refresh_token
string

The refresh token

Responses

Request samples

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

Response samples

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

Profile

Retrieve the profile

Authorizations:
Tenant Access Token

Responses

Response samples

Content type
application/json
{
  • "companyInformation": {
    },
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Set up profile details

Authorizations:
Tenant Access Token
Request Body schema: application/json
required
object
registrationNumber
required
string

The Companies House number

Responses

Request samples

Content type
application/json
{
  • "companyInformation": {
    }
}

Response samples

Content type
application/json
{
  • "companyInformation": {
    },
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Update profile

Update the profile

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

The Companies House number

Responses

Request samples

Content type
application/json
No sample

Tenants

Create a tenant

A tenant is property or product within a company.

Authorizations:
Master Access Token
Request Body schema: application/json
referenceId
string

A unique reference ID that you can pass over to identify this tenan

Responses

Request samples

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

Response samples

Content type
application/json
{ }

Retrieve tenants

Retrieve all tenants

Authorizations:
Master Access Token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {
    },
  • "meta": {
    }
}