Architecture
Each business has its own workforce, payroll, and payments — fully isolated by tenant key. Every API call that targets a specific business includes theX-MultiTenantKey header to identify which business you’re operating on.
Key Concepts
| Concept | Description |
|---|---|
| Platform Token | An API token with access across all businesses on your platform. Generated from the Dashboard after platform access is enabled. |
| Tenant Key | A unique identifier for each business (e.g., cad95193904). Returned when you create a business. |
| X-MultiTenantKey | The HTTP header used to specify which business a request applies to. Required for all business-specific operations. |
Platform vs Org Tokens
| Aspect | Org Token | Platform Token |
|---|---|---|
| Scope | Single organization | Multiple businesses |
| Business creation | Cannot create businesses | Can create businesses via API |
| X-MultiTenantKey | Not required | Required for business-specific calls |
| Use case | Single-business integration | Multi-tenant platform |
Business Lifecycle
| Status | Description | Can transact? |
|---|---|---|
pending | Created, awaiting KYB | No |
needsAdditionalInformation | KYB review requires more info | No |
active | Fully verified | Yes |
suspended | Temporarily disabled | No |