Partner accounts

This guide covers API key management for partner organisations. Partners use API keys to integrate with the Hubpay API for automated client onboarding, status tracking, or other programmatic workflows.

Who can manage API keys

Only users with the Partner Admin role can access API key management. Onboarding Agents do not have access to this feature.

As with corporate accounts, API access must be granted by Hubpay before the option becomes available. If your partner organisation requires API access, contact your Hubpay relationship manager.

Accessing API keys

1. Click on your account name at the top of the screen to open the account menu.

2. Select "API keys" from the menu, or navigate to Account Settings and select the "API keys" tab.

   

Creating an API key

1. Click the "Create API key" button on the API keys page.

2. Enter the email address to associate with the credential. This is used for identification and audit purposes.

   

3. Click Submit. Your new credentials will be displayed:

   • Client ID — use this to identify your application in API requests
   • Client Secret — use this to authenticate your requests
   • Account ID — the account identifier linked to this credential

   

Important: The Client Secret is only shown once. Copy and store it securely before closing this dialog. If you lose the secret, you will need to delete the key and create a new one.

Viewing existing keys

The API keys page displays a table of all active credentials for your partner account:

Column	Description
Client ID	The unique identifier for the API key
Email	The email address associated with the key
Created	The date and time the key was created

Deleting an API key

1. Click the delete button next to the key you want to remove.

2. Confirm the deletion in the dialog.

The key will be revoked immediately. Any integrations using that key will stop working as soon as it is deleted.