Prerequisites
API key from Dashboard
Get your API key from the Cadana Dashboard. See Authentication for details.
An active business (tenant key)
You need an active business with a tenant key. Platform integrators receive this from the
POST /v1/platform/businesses response. Direct API users can find it in the Dashboard under Settings > Business.Create an Entity
Create a legal entity under the current business tenant. Response:Required Fields
| Field | Description |
|---|---|
legalName | Legal name of the entity |
country | ISO 3166-1 alpha-2 country code (e.g., GH, NG, GB) |
currency | ISO 4217 currency code (e.g., GHS, NGN, GBP) |
Optional Fields
| Field | Description |
|---|---|
entityType | Legal structure: corporation, c-corporation, s-corporation, partnership, sole proprietorship, limited liability company, non profit, other |
address | Entity’s registered address |
phoneNumber | Entity’s phone number |
registrationNumber | Business registration number in the jurisdiction |
taxId | Tax identification number |
incorporationDate | Date of incorporation (YYYY-MM-DD) |
Entities start as
ACTIVE. KYB verification per entity is planned for a future phase.List Entities
Retrieve all entities under the current tenant. Response:Get a Single Entity
Response:Update an Entity
Update an existing entity. This is a partial update — only include the fields you want to change. Returns204 on success.
Link Persons to Entities
Assign a person to a specific entity by settingentityId in their job information via PUT /v1/persons/{personId}/jobInfo.
Returns 204 on success.
If
entityId is not set, the person is employed under the parent business. This is the default behavior and is fully backwards compatible — existing persons without an entityId continue to work as before.Statutory Compliance Impact
When a person is linked to an entity viaentityId, statutory filings use the entity’s employer details instead of the parent business’s. The entity fields used for compliance are:
| Field | Purpose |
|---|---|
taxId | Employer tax identification on statutory returns |
registrationNumber | Employer registration with government authorities |
country | Determines applicable jurisdiction and filing types |
address | Employer address on statutory returns |
Next Steps
Onboard Workers
Create Person records and assign them to entities during onboarding
Statutory Compliance
Automate filings and remittances for entity jurisdictions
Multi-Tenant Setup
Platform integration and business creation
Departments & Custom Fields
Organize workers by department and track custom metadata