In the extremely rare case that backwards-incompatible changes are made to the API, a new version is released with an updated URL:

In this case the updated V2 API will be documented and released, each customer will be notified and offered the chance to move to the latest version of the API.

Pagination

Versioning

The Full Profile Object

Get a Full Profile

Full profile object

Manual company profile import.

Search company profile import.

Sole Trader company profile import.

Import

Assigns a configuration to a company profile

Configuration list

Configuration

Assigns a risk score to a company profile

List of company profiles

View company profile

Update customer reference of a profile

Profiles

Update review status of a profile

Companies

Assign user to company profile

Un-assign user from company profile

List of users.

Users

Search for a company.

Search

Onboarding statuses for profile

Onboarding

List risk scores

Create risk score

View risk score

Delete risk score

Risk Score

Download OpenAPI file

Detected API

API Docs

Detected API Docs

Authentication

Error Handling

Webhook Payload

Profile Status

Profile Status Examples

Webhooks

APIs