Skip to main content
POST
companies.charities.lookup

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
charityNumber
string

Charity number.

Required string length: 1 - 512
name
string

Name.

Required string length: 1 - 512

Response

The result

charityName
string
required

Charity name.

description
string

Description.

status
string

Status.

latestEmployees
number

Latest employees: how many.

latestIncome
number

Latest income.

latestSpending
number

Latest spending.

latestVolunteers
number

Latest volunteers.

trusteeCount
number

Trustee: how many.

income
number

Income.

charityNumber
string

Charity number.

companyNumber
string

Company number.

dateOfRegistration
string

Date of registration, ISO 8601.

latestFinancialYearEnd
string

Latest financial year end, ISO 8601.

website
string

Website link.