Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Headers

X-Workspace-Id
string<uuid>

Partner / ISV only: UUID of the workspace that owns the client company. Required together with X-Acting-Company-Id when scoping product APIs to a merchant. See /getting-started/multi-tenancy.

X-Acting-Company-Id
string<uuid>

Partner / ISV only: UUID of the client company to act on. Must belong to the workspace in X-Workspace-Id.

Body

application/json
countryCode
string
required

Country ISO code (e.g., CM, NG)

Maximum string length: 2
ruleType
string
required

Rule type key used by payroll strategies (e.g., CNPS, TAX, PENSION, PAYE, NHF, NSITF, ITF)

Maximum string length: 30
effectiveFrom
string
required

Effective from date

effectiveTo
string
required

Effective to date

configJson
object
required

Frozen config payload used for deterministic computation

Response

Successful response