Skip to content
Last updated

Request access

API access is granted, not self-served. Before you receive credentials, you need the right agreement in place for your integration model. This page covers both paths.

If you have not yet established which model applies to you, start with Integration models.

What you will need

Have these ready before you make contact — supplying them up front avoids a round trip.

All integrations:

  • A company email address.
  • The name of the product or products you intend to integrate with.

Partners, additionally:

  • A description of your product, service or solution, and how it will use our APIs.
  • Your redirect URL for your development environment.
  • Your application logo, in JPG format.

Clients, additionally:

  • Which environments you need access to: sandbox, production, or both.
  • The name and contact details of the developer who will receive the credentials.
  • Your redirect URL, if you are using a consent-based flow.

Redirect URLs must be absolute and use https. Registered redirect URLs are matched exactly, including protocol, case and any trailing characters.

The Partner path

1. Register your interest

Email partners@class.com.au with a description of your product or solution and the products it will integrate with. Our Partnerships team will get in touch.

2. Complete due diligence and NDA

You will be asked to complete and return a due diligence form and an NDA. Our Compliance team reviews these. The security assessment and Partner Agreement come later — they do not block your access to the sandbox.

3. Initial meeting

The Partnerships team will arrange a meeting to discuss your integration in more detail, confirm which APIs you need, and agree on scope.

4. Receive sandbox credentials

Once the initial review is complete, we issue credentials for the sandbox environment so your developers can begin building. Provide your redirect URL and logo at this point if you have not already.

5. Build your integration

Develop and test against the sandbox. In parallel, the Partner Agreement is negotiated, covering commercial terms (if applicable), use of the APIs and any single sign-on services.

6. Request production review

When your integration is complete, contact us to begin the review. You will need to demonstrate your application and complete the security assessment. See Production readiness for exactly what is assessed.

7. Receive production credentials

Once the review is approved and the Partner Agreement is signed, we issue production credentials so you can deploy.

8. Launch

We can support your launch with a marketing brief and promotion of your integration to our client base. Your Partnerships contact will arrange this.

The Client path

1. Confirm your agreement is in place

Client API access requires a current service agreement. If your business holds an older form of agreement, it may need to be updated before API access can be granted — we will confirm this when you make contact.

This request must come from an Access Controller in your business, or someone with equivalent authority. We cannot issue credentials on the request of an individual developer without that authorisation.

2. Send your request

Email partners@class.com.au requesting API access. Include:

  • The product you need access to.
  • Which environments you need: sandbox, production, or both. Credentials are issued per environment and do not carry across.
  • The authorisation flow you intend to use.
  • The contact details of the developer who will receive the credentials.

3. Review and verification

We review your request for API use and verify your agreements are current.

4. Receive confirmation

We confirm your integration is approved and tell you which environments your access covers.

5. Receive your credentials

We issue your API credentials to your nominated developer. Store them securely — treat the client secret as a password, keep it in your backend, and never place it in client-side code or a source repository.

Product-specific details

Onboarding contacts and agreements are handled centrally, but the APIs, environments and technical requirements differ by product. Once you have access, see your product's documentation: