You can now map between individuals, sole traders, and organisations with their associated clients.

What's been added

• GET /individuals and GET /individuals/:id — Each individual that is also a client (i.e. client type is individual) now includes a nested client object with links and ID.
• GET /organisations and GET /organisations/:id — Organisation entities that are also clients now includes a nested client object with links and ID.
• GET /sole-traders and GET /sole-traders/:id — Sole trader entities now includes a nested client object with links and ID.
• GET /clients — Each client's entity reference now includes links (self and web) back to the underlying individual, organisation, or sole trader.

We’ve rolled out a significant number of new API endpoints to make managing all of a firm’s clients, organisations, and individuals even more convenient through the API:

New endpoints:

• List and Manage Individuals:
  • GET /individuals: List all individual records.
  • GET /individuals/{id}: Retrieve a single individual’s details.
  • PATCH /individuals/{id}: Update an individual’s profile.
• List and Manage Organisations:
  • GET /organisations: List all organisations
  • GET /organisations/{id}: Retrieve details for a single organisation.
  • PATCH /organisations/{id}: Update an organisation’s profile.
• Related parties (of an organisation):
  • GET /organisations/{organisationId}/related-parties: List related parties for an organisation
  • POST /organisations/{organisationId}/related-parties: Create a related party for an organisation
  • PATCH /related-parties/{id}: Update a related party
  • DELETE /related-parties/{id}: Delete a related party from that organisation
• List and manage Sole Traders:
  • GET /sole-traders: List all sole trader records.
  • GET /sole-traders/{id}: Retrieve details for a single sole trader.
  • PATCH /sole-traders/{id}: Update a sole trader’s profile.
• Client management:
  • PATCH /clients/{id}: Update client-specific details (services, business units, managers).

For the authenticated firm, return a list of the Business Units, Services, and Staff (including roles) that have been set up for that firm. For all details see https://developer.firmcheck.com/reference/getfirm#/

The Firmcheck API is officially version 1 and out of beta. Big thank you to our beta testers that were giving us feedback with our early versions of the API 😃

We have 3 API endpoints available:

• Get client list
• Get client
• Create client (Individual, Sole traders, Companies House companies)

And more endpoints will be added over time! Please refer to the API reference documentation for more details on these API requests.

For those that were connected to our API during beta, due to some breaking changes there are some actions required as we move to Version 1.0 :

• Generate new API keys – we've had to make a breaking change to how we hash the API keys, and unfortunately this will mean you need to generate a new key to continue getting access.
• Changed name from contact to entity in the Client endpoints when referring to the client type (organisation, individual or sole trader). Based on feedback on the term contact, we have changed this to entity – and that will mean any references you have to this will need to be updated.

• We've added the parameter sinceModifiedAtto the clientList request, this will filter only clients that have had changes since the date you specify.
• You can now create clients using a UK Companies House company number. When creating the client, Firmcheck will also pull the directors and PSCs and include them with that client as related parties. Please see https://developer.firmcheck.com/reference/createclient#/ for more details.
• A bug where the clientList was including discarded and archived clients has been fixed, the request now only returns clients that have the state PROSPECT and EXISTING.