KYCCentral.Charity (KYC Central v0.9.0)

Copy Markdown View Source

Charity Commission for England and Wales lookups.

Summary

Functions

A charity's register entry.

Search registered charities by name.

Whether Charity Commission access is configured.

The charity's registered trustees.

Types

result()

@type result() :: {:ok, map()} | {:error, KYCCentral.Error.t()}

Functions

get(client, registration_number, opts \\ [])

@spec get(KYCCentral.t(), String.t(), keyword()) :: result()

A charity's register entry.

Options

  • :suffix — subsidiary suffix, for linked charities registered under one number. Defaults to the parent entry.

search(client, q)

@spec search(KYCCentral.t(), String.t()) :: result()

Search registered charities by name.

status(client)

@spec status(KYCCentral.t()) :: result()

Whether Charity Commission access is configured.

trustees(client, registration_number)

@spec trustees(KYCCentral.t(), String.t()) :: result()

The charity's registered trustees.