Configuring the Charity Commission of England and Wales

The Charity Commission of England and Wales is a data provider you can use to run the Charities registry check.

How it works

This is the default behaviour for a variant of the Charities registry check with the Charity Commission as the data provider.

The check is performed by searching the charity’s country of incorporation and registration number in the registry of the Charity Commission.

The check passes when the charity is found and at least one trustee is discovered.

When the check passes, the check results are displayed as follows:

  • On the Identify trustees task, the names of the trustees are displayed in the check results, along with any available information about their roles, dates they were appointed, and dates they resigned.
  • On the Verify charity details task, basic information about the charity is displayed in the check results (e.g. charity commission number, registration date, company number, areas of activity, and total expenditure).

If the charity cannot be found, the check fails.

If the charity’s country of incorporation isn’t England or Wales, an error is displayed.

Configuration options

There are no additional configuration options for the Charities registry check variant with the Charity Commission.

However, this check is used on the Identify trustees task, which includes configuration options to control how the trustees returned by the Charity Commission are verified. Learn more about task configuration options.

What we'll need

Let us know that you'd like to add a Charities registry check variant with the Charity Commission of England and Wales and we'll set it up.

If you'd like to use any of the configurations for the Identify trustees task, please let us know which ones you'd like to use.

If you want to use your own API key for the Charity Commission, you can get one from their developer console: https://apps.charitycommission.gov.uk/Showcharity/APIConsole/APIConsoleHome.aspx

You'll need to register for the developer console before you can use it.

Once you've got your API key, send it to us and we'll add it to your configuration.

If you don't want to use your own Charity Commission API key, that's fine too - just let us know and we'll configure the check variant that way.

Testing your configuration

Once the check variant is configured, follow these steps in your demo environment to test whether it's working as expected.

To test the Identify trustees task:

  • Are charity trustee results returned from the Charity Commission? Create any company profile for a charity incorporated in England or Wales and run the check variant. If the check passes and real data for trustees is returned in the check results, the check variant is working as expected.

To test the Verify charity details task:

  • Is basic information about the charity returned from the Charity Commission? Create any company profile for a charity incorporated in England or Wales and run the check variant. If the check passes and real data about the charity is returned in the check results, the check variant is working as expected.
In the live environment, an error is displayed when the check variant is run on a profile with a country of address that isn't the UK. This error is not displayed in the demo environment.
The data displayed in the check results is real data from the Charity Commission, even in the demo environment.

Required and optional profile fields

These are the company's profile details searched in the Charity Commission:

Name

Description

Country of incorporation (metadata.country_of_incorporation)

Required

The country in which the charity is incorporated.

Company number (metadata.number)

Optional

The charity's registration number.


How did we do?


Powered by HelpDocs