API usage guidelines

Efimis provides documented APIs so clients / partners and their authorised developers can connect Efimis to other systems, automate work and access their own data. Integrations should use the documented API methods, respect the permissions granted to the integration, and operate within the published technical limits.

Permitted integrations

Clients may use the Efimis API for their own business purposes, including discrete transactions, reporting and synchronising defined data with their own or third-party systems.

An integration may access only the tenant, data and functions for which it has been authorised. The client is responsible for deciding which third-party systems receive its data and for ensuring that its use of those systems meets its legal, confidentiality and security obligations.

Rate limits and reliable requests

Requests are limited separately for each integration and tenant. The current platform default is 100 requests per 60 seconds. An integration may have a different agreed limit or replenishment period.

If the API returns 429 Too Many Requests, follow the Retry-After header when supplied. Otherwise, retry with exponential backoff. Do not automatically repeat a write request unless doing so is safe and will not create duplicate records.

Contact Efimis if a planned integration needs sustained throughput above its current limit. A higher limit must be agreed and it should not be assumed from this page.

Responsible use

Keep credentials secure and do not share them between unrelated integrations. Do not bypass authentication, permissions or rate limits, or use scraping or other undocumented methods to access Efimis. Integrations must not disrupt the security, availability or performance of Efimis or other clients’ use of the service.

Efimis may restrict access where reasonably necessary to protect the platform or respond to suspected unauthorised or harmful use. We will communicate with the affected client where practicable.

Large-scale extraction and replication

The API supports ordinary transactions, defined synchronisation and access to records needed for an integration. If you plan to extract a substantial proportion of a tenant’s data on a continuing basis, or maintain a standing replica of its financial dataset outside Efimis, contact us before implementation. We will work with you to identify a supported approach, appropriate capacity and any additional arrangements needed.

This does not prevent discrete API access, a defined field synchronisation, or use of an export or migration method that Efimis has made available for that purpose.

Questions and changes

Contact connections@efimis.com to discuss access, a proposed integration or a custom rate limit. Technical behaviour and available methods are described in the API documentation; changes are published through the developer changelog.