API FAQs

Written By Jessica Moore (Super Administrator)

Updated at May 8th, 2026

Does SchemeServe support webhooks or event-based updates?

Yes. SchemeServe supports event-driven integrations via configurable rules.

You can define rules that trigger API requests when specific lifecycle events occur (e.g. when a case goes on cover). This allows data to be pushed to external systems in real time.

If required, SchemeServe can provide a walkthrough of how to configure these rules.

 
 

What are the API rate limits?

The SchemeServe API enforces the following rate limit:

  • 100 requests per rolling 60-second window
  • This limit applies across the entire API, not per endpoint

Clients should implement appropriate throttling and retry logic to remain within these limits.

 
 

An incremental / staged data integration approach is recommended.

Rather than attempting a full data sync upfront, integrations should:

  • Start with core datasets
  • Validate data flows and structure
  • Expand coverage iteratively

This reduces risk and improves stability during implementation.

 
 

Are there any known API constraints or structural limitations?

Parent vs Child Site Data Access

There is a known issue affecting data access between parent and child sites (Network-level behaviour).

  • This is a recognised issue
  • SchemeServe is actively working on a resolution
     

Child Site Accounting Dependency

Some data is only accessible via the API if Accounting is enabled on the site.

This includes:

  • Transactions
  • Financial data

SchemeServe uses Digit as its accounting platform, and API exposure of financial data is tied to this functionality.

Important consideration:

Even if Accounting is not required operationally on a Child Site, it may still need to be enabled to:

  • Access financial data via API
  • Support MI (Management Information) and reporting requirements

Interim workaround:

For testing purposes, Accounting can be enabled on specific Child Sites (e.g. “The Retail Mutual”) to allow API access to required datasets.

 
 

What data can be accessed via the API?

Subject to configuration and Accounting enablement (where required), the following data is available via the SchemeServe API:

  • Transactions
  • Reports
  • Entity History
  • Payable
  • Receivable

⚠️ Note: On Child Sites, access to some of these datasets is currently restricted unless Accounting is enabled.

 
 

Are there any known bugs affecting the API?

Yes. There are currently known issues (including structural/data access constraints) that are under active investigation by SchemeServe.

Updates will be provided as fixes are deployed.