Skip to content

Security & Access Model

Security is a foundational pillar of the Portal API. Because the Portal API serves external partners, both API traffic and the hosted documentation site are isolated to prevent unauthorized access and data leakage.


Partner HTTP Request
│
├─► [Authorization: Bearer <YOUR_PARTNER_API_KEY>]
│
▼
Portal API Gateway
│
├─► Authenticates API key and resolves partner account identity
│
▼
Tenant-Scoped Platform Operations
│
▼
Partner Isolated Datastores & Ledgers

All HTTP requests directed to the Portal API must supply an authorized API key in the Authorization header:

Authorization: Bearer <YOUR_PARTNER_API_KEY>

The gateway extracts the bearer token and validates it with the platform authentication provider.

  • Each partner API key resolves to a single partner organization. The key is shown once, when it is generated: the platform stores only its SHA-256 hash, so a lost key cannot be recovered and must be regenerated, which invalidates the previous one.
  • Campaign and line-item reads, and campaign updates, are bound to that organization’s boundary.
  • Cross-Account Prevention: Partners can only view campaigns and line items belonging to their own organization. Line item budgets are always drawn from that organization’s own wallet, resolved server-side. Banker IDs supplied when upserting line items are also checked against that organization; unknown or out-of-scope IDs are rejected with BAD_REQUEST.

The /mcp endpoint requires the same Authorization: Bearer <YOUR_PARTNER_API_KEY> header. Each tool call is forwarded to the matching Portal API operation and goes through the same authentication, validation and tenant isolation as a REST call, so an assistant can never do more than the API key allows.

  • Store the API key in your OS keyring or your client’s secret storage rather than in a plain text configuration file. See AI Assistants (MCP) for per-client setups.
  • Tools that modify data carry MCP hints flagging them as write or destructive operations. Clients that honour these hints can ask for confirmation before running them, but auto-approve modes skip it.