The partner page

A partner platform calls Advisor's tools with no person present, so nobody can sign in on its behalf. The partner page lets an Advisor AI Pro subscriber issue that platform an API key. Every call made with the key works like the subscriber's own connection: the same tools, the same rules, billed to the same subscription.

Before you begin

Steps

  1. Create the organisation. Enter its name, ABN (or a registration number outside Australia) and a technical and a security contact email.
  2. Accept the partner terms for the organisation. This is required. The text is shown in full with its version, and the acceptance is recorded with who, when and from which address.
  3. Accept the Hansard conditions of use, if you need Hansard. Without them, the Hansard tools refuse the organisation's keys with TERMS_REQUIRED. See Hansard.
  4. Add a client for each workload or environment, for example "pilot" and "production". Each client has its own scopes, rate limit and optional address allowlist, so one can be stopped without stopping the others.
  5. Issue a key. It is shown once, with the endpoint and the header to send. Store it in a secret manager. See Partner API keys.

Check it worked

Call health with the key. The response has "status": "ok" and a partner_key block giving the key's last four characters and when it expires. See Connect a client.

What to do if it did not

See Troubleshooting.

What is not available yet

Next steps