Skip to main content
GET
Get jurisdiction details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

country_code
string
required

ISO 3166-1 alpha-2 country code

Pattern: ^[A-Z]{2}$

Response

Jurisdiction details

countryCode
string
Example:

"MX"

countryName
string
Example:

"Mexico"

currency
string
Example:

"MXN"

status
enum<string>
Available options:
live,
coming_soon
payrollFrequency
enum<string>
Available options:
MONTHLY,
BIWEEKLY,
SEMI_MONTHLY,
WEEKLY
employeeFields
object

Flat list of fields required for tax calculation and/or statutory filing in a jurisdiction. Each field includes its entity (person or business), scope (calculation, filing, or both), and validation rules.

Fields with entity: "person" are worker-level data. Fields with entity: "business" are employer-level data. Use the entity field to build separate onboarding forms for workers and employers.

employerFields
object

Flat list of fields required for tax calculation and/or statutory filing in a jurisdiction. Each field includes its entity (person or business), scope (calculation, filing, or both), and validation rules.

Fields with entity: "person" are worker-level data. Fields with entity: "business" are employer-level data. Use the entity field to build separate onboarding forms for workers and employers.

filingTypes
object[]
statutoryBenefits
object[]
compliance
object
termination
object