Partner API Key
A Partner API Key authenticates integrating platforms at the first layer of API access. The platform stores only api_key_hash. A plaintext key is returned once at create time and is never returned again.
Role in the platform
Partner keys gate partner-facing routes before user or organisation context is applied. Operators rotate keys by creating a new key and retiring the previous one. See Partners and Authentication.
Core fields
| Field | Description |
|---|---|
key_uuid | Public key record identifier |
partner_name | Partner display name |
status | Key lifecycle (Active and related states) |
created_at / created_by | Creation audit |
updated_at / updated_by | Last update audit |
api_key_hash is stored server-side for verification. Integrators receive the plaintext key only in the create response.
Related APIs
Last updated on