The Annature API includes a set of advanced capabilities designed for software providers and platform integrators who need to provision and manage multiple organisations through a single integration. These features are only available through our Partner Program, and are protected due to their elevated access and potential for misuse. Partners are typically software providers, platform integrators, or workflow enablers who need to provision, manage, or automate across multiple organisations using a single integration.

​
How it works

When you’re approved as a partner, you’ll be issued a separate Partner API key, which must be supplied on a per-request basis via the X-Annature-Partner HTTP header. Providing this header changes the behavior of certain endpoints — unlocking extended capabilities that are otherwise unavailable or restricted. If the X-Annature-Partner header is not included, the endpoint behaves as it normally would for standard API users. This lets partners operate in both contexts:
  • With the header: You’re acting in a partner-managed mode
  • Without the header: You’re using your API key as a normal organisation user

​
What partners can do

Approved partners gain access to the following capabilities when the X-Annature-Partner header is present:
  • Register a new organisation and account in a single request
    The Register organisation endpoint allows partners to create a brand new organisation and its first user in one API call. This endpoint is completely disabled unless the partner header is present.
  • Skip email verification during account creation
    The Create account endpoint normally requires all new users to verify their email address before signing in. By including the skip_verification flag and the X-Annature-Partner header, partners can bypass this requirement when creating accounts programmatically.     If skip_verification is provided without the partner header, the request will be rejected.
  • List accounts across all registered organisations
    The List accounts endpoint normally returns accounts within a single organisation. When called with the partner header, it returns accounts across all organisations that the partner originally registered. This is useful when you need a complete view of every account provisioned by your integration.
  • Impersonate an account by creating a session
    Partners can use the Create session endpoint to generate an authenticated session for any account they’ve provisioned — without requiring the user’s email or password. This enables features like embedded support dashboards or seamless SSO experiences.     This should only be used for accounts you’ve created and actively manage. Sessions must be scoped securely.

​
How to become a partner

To request access to the Partner Program, email us at hello@annature.com.au. We’ll ask you to complete a short due diligence process to confirm your business model and ensure the API will be used responsibly. Once approved, you’ll be issued a Partner key that you must include via the X-Annature-Partner header in any requests that require partner privileges.