Skip to main content
The Platform API lets you manage multiple businesses from a single integration. You get one API token that can create businesses, onboard workers, run payroll, and process payments across all of them — each isolated by a unique tenant key. This is purpose-built for HR platforms, payroll providers, talent marketplaces, staffing platforms, and international HR providers.

Architecture

Each business has its own workforce, payroll, and payments — fully isolated by tenant key. Every API call that targets a specific business includes the X-MultiTenantKey header to identify which business you’re operating on.

Key Concepts

ConceptDescription
Platform TokenAn API token with access across all businesses on your platform. Generated from the Dashboard after platform access is enabled.
Tenant KeyA unique identifier for each business (e.g., cad95193904). Returned when you create a business.
X-MultiTenantKeyThe HTTP header used to specify which business a request applies to. Required for all business-specific operations.

Platform vs Org Tokens

AspectOrg TokenPlatform Token
ScopeSingle organizationMultiple businesses
Business creationCannot create businessesCan create businesses via API
X-MultiTenantKeyNot requiredRequired for business-specific calls
Use caseSingle-business integrationMulti-tenant platform

Business Lifecycle

StatusDescriptionCan transact?
pendingCreated, awaiting KYBNo
needsAdditionalInformationKYB review requires more infoNo
activeFully verifiedYes
suspendedTemporarily disabledNo
A business must complete KYB verification before it can process payments.

Getting Started