Skip to main content

CreateApiKeyDto

namestringrequired

Human-readable label shown in dashboards and audit logs.

Possible values: >= 3 characters and <= 120 characters

Example: Bank of Uganda payment gateway integration
scopesstring[]required

System permissions the key may act with. Must be a subset of the platform catalogue.

expiresAtstring

ISO date after which the key stops working.

ownerTypestring

Partner organisation code, insurer, etc.

Possible values: non-empty and <= 60 characters

ownerIdstring
rateLimitPerMinnumber

Max requests per minute for this key. Null = fall back to global limit.

Possible values: >= 1

allowedIpsstring[]

Allowlist of IP addresses that may present this key. Empty = unrestricted.

CreateApiKeyDto
{
  "name": "Bank of Uganda payment gateway integration",
  "scopes": [
    "string"
  ],
  "expiresAt": "string",
  "ownerType": "string",
  "ownerId": "string",
  "rateLimitPerMin": 0,
  "allowedIps": [
    "string"
  ]
}