givvable API access

givvable's APIs can be accessed via https://data.givvable.com (Data Portal) which provides documentation, latest changes, announcements and compliance-related tasks.

The integrations and consumption of givvable's APIs is intended to be used by a qualified software engineers. givvable's APIs currently support the REST standard only. givvable provides various automated documentation formats such as OpenAPI Specification and WADL which can be used to create POSTMAN collections to aid with implementation.

The API utilizes a subscription key that must be passed in the header of each request. Subscription keys are managed through givvable's Data Portal. By default, users of givvable's APIs have two keys available for use with requests.

To access the Data Portal, givvable users must create an account by following these steps:

1. Navigate to https://data.givvable.com

2. Click "Sign Up" in the top right-hand corner

3. Complete your details

4. Accept givvable's Terms of Service & Privacy Policy

With Data Portal access, givvable users can:

A. Manage your Subscription Keys (https://data.givvable.com/docs/products)

B. Access usage reports

C. View documentation

D. Access compliance documentation (Notes & Disclaimers)

givvable recommends rotating keys every 6 to 12 months to reduce the risk of key theft or misuse.

All calls to givvable's APIs are recorded for monitoring, debugging, billing and compliance purposes.

givvable users with access to givvable's premium or portfolio APIs are generally charged based on the number of API calls to the following endpoints: getOrganisationByIdentifier or getOrganisationById. If you would like to discuss other billing models, please contact sales@givvable.com.

A successful API call is one that returns data (response code 200). Each time this data is returned, it will be counted as one successful API call for the purposes of billing. If you call the same organization multiple times you will be charged for each successful API call.

If there is no retrievable data on the organization you are trying to look up, the endpoint will respond with a 404 (not found) status, which is considered an unsuccessful API call.

givvable's APIs will start throttling calls if a large quantity of calls is made within a short period of time. If you are getting “Too many requests” response, it is most likely because you are making too many requests per minute on your API key. Please contact us at support@givvable.com if you would like your request ratio be adjusted.

givvable is required by credential issuers to ensure their credentials are not misrepresented or used inappropriately. Therefore, givvable require any partner or givvable user that displays credentials from givvable to clearly display Notes & Disclaimers. For full technical documentation on how to obtain and implement Notes & Disclaimers, please visit https://data.givvable.com/docs/notes-and-disclaimers-guide

To gain access to givvable's premium or portfolio APIs, please reach out to sales@givvable.com.

If you are a partner or givvable user, subject to terms & conditions in your Order Form, you will most likely be charged for successful API calls to getOrganisationByIdentifier and getOrganisationById. Invoices are issued on the last day of every month based on successful API calls made during that period. UTC timezone is used for all reporting and billing purposes. The record of usage is prvovided as part of your invoice for the purposes of calculating billing.

If you would like to discuss other billing models, please contact sales@givvable.com.

We understand that retrieving large amounts of data has performance implications. Therefore, we allow caching on the consumer side for up to 24 hours. This limitation exists because our data is continuously updated, and caching for longer periods would create a high risk of using stale and potentially inaccurate data.