Skip to main content
Some Veridox API features are optional. They are not enabled by default, and their endpoints work only once the feature is enabled for your organisation.

​
How Feature Modules Work

When you call an endpoint that requires a feature module that has not been enabled for your organisation, the API returns a 403 Forbidden response with the following error:
This is distinct from a permissions error — your API key is valid, but the feature itself has not been activated.

​
Getting a Feature Enabled

If a feature is not enabled for your organisation, ask your organisation admin. They can contact Veridox to see whether it can be enabled.

​
Feature-Gated Endpoints

The following API sections require their respective feature module to be enabled:

​
Early Access Features

Some features are available to early access organisations only and are not feature modules. They do not appear in enabled_feature_modules on Get Current User, and their endpoints return 403 with request.organisations.feature-flag.not-enabled rather than request.organisations.module.not-enabled when your organisation does not have them. If the feature has a read endpoint, call it and check for that error to find out whether you have the feature. To request access, ask your organisation admin. They can contact Veridox to see whether it can be enabled.