Release Update: New API Endpoints for Managing Elements API Credentials
We’ve introduced new endpoints to automate the management of API keys for the Elements API:
1. Create API Key
POST /api-keys/v1/create
- Generate a new API key for accessing the Elements API.
- Keys can be created at the organisation or Service Organisation Partner (SOP) level.
- By default, keys are read-only for security. Optionally, set
readOnly to false for write access. - Important:
clientSecret is returned only once during creation—store it securely.
2. Delete API Key
DELETE /api-keys/v1/api-keys/{clientId}
- Permanently remove an API key by its ID.
- Deleted keys cannot be recovered or used for authentication.
3. List API Keys
GET /api-keys/v1/api-keys
- Retrieve all API keys for the current organisation or specify an
organizationId when querying from SOP level.
For full details, including request/response formats and examples, refer to the API documentation.