API Users

API users provide programmatic access to the platform. They authenticate with a key and secret rather than email and password, and are scoped to a specific client with a fixed set of permissions.

Creating an API User

1. Go to User Management in the platform
2. Click Create API User
3. Give it a name and select the permissions it needs
4. Copy the API key and secret — the secret is shown only once

Credentials

Your API user receives two values:

• Key ID — starts with numis_, used as the x-api-key header
• Secret — used as the x-api-secret header, treat it like a password

See Authorization for how to include these on every request.

Permissions

Each API user is granted a specific set of permission scopes at creation time. A platform admin can update them at any time. Common scopes:

• Initiate new custody account — create new custody accounts
• View custody account — read account information
• View whitelisted address — read whitelisted destination information
• Initiate transaction — submit new transactions
• Initiate account transactions — submit new transactions
• Initiate external wallet address — submit new external destination requests

Managing API Users

• API users appear alongside regular users in User Management
• Permissions can be updated without recreating the credential
• Revoking a credential immediately rejects all subsequent requests made with it
• All API activity is logged and visible in the audit trail