Skip to main content
An application is how your systems authenticate with Zeam. Registering one returns a set of application credentials: a client ID, a client secret, and an API key. New applications are issued sandbox credentials by default.

​
Before you start

  • Access to the Zeam business portal for your company.
  • Permission to manage applications for the business. If you do not have it, ask an administrator to register the application and share the credentials with you through a secure channel.

​
Register an application

1

Open Application Registration

Sign in to the business portal, open the Settings menu, and choose Application Registration.
The business portal Settings dropdown menu with the Application Registration item highlighted.

Settings menu with Application Registration selected.

2

Review your applications

The Application Registration page lists your existing applications with their Client ID, Status, Secret expires, and Created date. Select Register application to add a new one.
The Application Registration page showing one application named Zeam Trader with a truncated client ID, an Active status, a secret expiry date, and a created date.

The Application Registration page listing a registered application.

3

Name the application

Enter an Application name that you will recognise later, then select Register. The name is the only field you provide.
The Register application dialog with an empty Application name field showing the placeholder e.g. Settlement Integration.

The Register application dialog before entering a name.

The Register application dialog with the Application name field filled in as Zeam Trader.

The Register application dialog with a name entered.

The Register application dialog showing a Registering progress state on the Register button.

The dialog while the application is being registered.

4

Copy your credentials

Registration returns the application’s credentials once. Copy all three and store them in a secure secrets manager before you close the dialog.
The Application credentials dialog for Zeam Trader, showing a one-time warning, the application name, a redacted client ID, a masked client secret, and a masked API key, with a confirmation checkbox and a Done button.

The one-time application credentials dialog. The client ID is redacted here.

  • Client ID (clientId): public identifier for the application.
  • Client secret: used with the client ID to issue an access token.
  • API key (apiKey): sent as the x-zeam-auth header on every request.
Select I have copied and securely stored these credentials, then Done.
The client secret and API key are shown once, at registration, and cannot be retrieved again. If you lose them, register a new application.

​
Protect your credentials

  • Never commit credentials to source control.
  • Never expose the client secret or API key in browser-side code.
  • Store credentials in a secure secrets manager, not in plain files.
  • Do not share credentials through email, chat, screenshots, or support tickets.
  • Keep sandbox and production credentials separate. See Moving to production.

​
Use the credentials to authenticate

The three credentials map to the request as follows:
  • The client ID and client secret are exchanged for a bearer token at POST /v1/auth/token. The token response includes your associationId.
  • The API key is sent as the x-zeam-auth header on every protected request.
  • The associationId from the token response is sent as the x-association-id header on every protected request.
See Authentication for the full model, or Your first transaction for a worked example.

​
Environment and status

  • Environment: new applications start in the sandbox.
  • Status: an application shows as Active once registered.
  • Secret expiry: the Secret expires column shows when the current client secret expires.

​
Prepare for production

When your integration works end to end in the sandbox, follow Moving to production to request production access and credentials.