> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cadanapay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get jurisdiction details

> Returns full configuration for a jurisdiction: required employee fields,
filing types, statutory benefits, compliance rules, and termination rules.

The embedded field lists (`employeeFields`, `employerFields`) cover
filing-scope fields only. For the complete set — including
calculation-scope fields — use
`GET /v1/statutory/jurisdictions/{country_code}/required-fields`.




## OpenAPI

````yaml /openapi/statutory-compliance.yaml get /v1/statutory/jurisdictions/{country_code}
openapi: 3.0.0
info:
  title: Statutory Compliance API
  version: 0.1.0
  description: Statutory filing, government remittance, and compliance tracking API
  termsOfService: https://cadanapay.com/terms-and-conditions
  contact:
    email: api@cadanapay.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.cadanapay.com
    description: Prod Server
  - url: https://dev-api.cadanapay.com
    description: Dev Server
security:
  - Authorization: []
tags:
  - name: Jurisdictions
    description: Discover supported countries, required fields, and filing types
  - name: Filings
    description: >-
      Create, submit, and track statutory returns — from upcoming obligations
      through acceptance
  - name: Remittances
    description: Government payments linked to filings
  - name: Requirements
    description: Prerequisites that must be satisfied before filing
  - name: Events
    description: Immutable audit trail
  - name: Statutory Fields
    description: Submit and read entity-level statutory filing data
paths:
  /v1/statutory/jurisdictions/{country_code}:
    get:
      tags:
        - Jurisdictions
      summary: Get jurisdiction details
      description: >
        Returns full configuration for a jurisdiction: required employee fields,

        filing types, statutory benefits, compliance rules, and termination
        rules.


        The embedded field lists (`employeeFields`, `employerFields`) cover

        filing-scope fields only. For the complete set — including

        calculation-scope fields — use

        `GET /v1/statutory/jurisdictions/{country_code}/required-fields`.
      operationId: getJurisdiction
      parameters:
        - $ref: '#/components/parameters/XMultiTenantKey'
        - $ref: '#/components/parameters/CountryCode'
      responses:
        '200':
          description: Jurisdiction details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Jurisdiction'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    XMultiTenantKey:
      name: X-MultiTenantKey
      in: header
      required: false
      schema:
        type: string
      description: >-
        Required when using a Platform API token. The tenant key identifying
        which business to operate on.
    CountryCode:
      name: country_code
      in: path
      required: true
      schema:
        type: string
        pattern: ^[A-Z]{2}$
      description: ISO 3166-1 alpha-2 country code
      example: MX
  schemas:
    Jurisdiction:
      type: object
      properties:
        countryCode:
          type: string
          example: MX
        countryName:
          type: string
          example: Mexico
        currency:
          type: string
          example: MXN
        status:
          type: string
          enum:
            - live
            - coming_soon
        payrollFrequency:
          type: string
          enum:
            - MONTHLY
            - BIWEEKLY
            - SEMI_MONTHLY
            - WEEKLY
        employeeFields:
          $ref: '#/components/schemas/RequiredFieldsResponse'
        employerFields:
          $ref: '#/components/schemas/RequiredFieldsResponse'
        filingTypes:
          type: array
          items:
            $ref: '#/components/schemas/FilingType'
        statutoryBenefits:
          type: array
          items:
            $ref: '#/components/schemas/StatutoryBenefit'
        compliance:
          $ref: '#/components/schemas/ComplianceInfo'
        termination:
          $ref: '#/components/schemas/TerminationInfo'
    RequiredFieldsResponse:
      type: object
      description: |
        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.
      properties:
        countryCode:
          type: string
          example: MX
        workerType:
          type: string
          enum:
            - employee
            - contractor
          example: employee
        version:
          type: integer
          description: |
            Schema version number, per jurisdiction. Increments when fields are
            added, removed, or changed for this country. Use this to detect
            when your cached field list is stale.
          example: 3
        fields:
          type: array
          items:
            $ref: '#/components/schemas/RequiredField'
      required:
        - countryCode
        - version
        - fields
    FilingType:
      type: object
      description: >
        A type of statutory return that must be filed in a jurisdiction.

        Filing types vary by country — use `GET
        /jurisdictions/{countryCode}/filing-types` to retrieve them.
      properties:
        id:
          type: string
          example: ft_mx_isr_monthly
        name:
          type: string
          example: ISR Withholding
        description:
          type: string
          example: ISR income tax withholding return filed monthly with SAT
        governmentFormName:
          type: string
          description: >
            The official form number or system name used by the government
            authority.
          example: Declaración Provisional ISR
        authority:
          type: object
          properties:
            id:
              type: string
              example: auth_mx_sat
            name:
              type: string
              example: Servicio de Administración Tributaria
            abbreviation:
              type: string
              example: SAT
        frequency:
          type: string
          enum:
            - MONTHLY
            - BIMONTHLY
            - QUARTERLY
            - SEMI_ANNUAL
            - ANNUAL
            - EVENT_DRIVEN
            - PER_PAY_PERIOD
          example: MONTHLY
        dueDay:
          type: integer
          description: Day of the month/quarter the filing is due (where applicable).
          example: 10
        includesRemittance:
          type: boolean
          description: Whether this filing type requires a government payment
          example: true
        legislativeReference:
          type: string
          description: Citation to the law requiring this filing
          example: Ley del Impuesto Sobre la Renta (LISR), Artículo 96
    StatutoryBenefit:
      type: object
      properties:
        name:
          type: string
          example: IMSS Employer-Employee Contributions
        description:
          type: string
          example: >-
            Mandatory social security contribution under the Ley del Seguro
            Social (LSS)
        employerRate:
          type: number
          format: decimal
          example: 0.1
          description: Employer contribution rate (as decimal)
        employeeRate:
          type: number
          format: decimal
          example: 0.08
          description: Employee contribution rate (as decimal)
        authority:
          type: string
          example: IMSS
        legislativeReference:
          type: string
          example: Ley del Seguro Social (LSS), Artículo 39
    ComplianceInfo:
      type: object
      properties:
        workingHoursPerWeek:
          type: integer
          example: 48
        annualLeave:
          type: string
          example: 12 working days after 1 year, increasing with seniority
        sickLeave:
          type: string
          example: Up to 52 weeks (60% pay via IMSS after 3-day waiting period)
        publicHolidays:
          type: string
          example: Paid, nationally observed (approx 7 mandatory rest days)
        probationPeriod:
          type: string
          example: 30 days (up to 180 days for managerial/technical roles)
        onboardingTimeline:
          type: string
          example: 5-10 business days
        payrollCutoffs:
          type: object
          properties:
            inputs:
              type: string
              example: 5 business days before pay date
            approval:
              type: string
              example: 3 business days before pay date
    TerminationInfo:
      type: object
      properties:
        noticeRequired:
          type: boolean
        description:
          type: string
        finalPayIncludes:
          type: array
          items:
            type: string
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
              example: countryCode is required
            details:
              type: array
              nullable: true
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
    RequiredField:
      type: object
      description: A single field required for tax calculation and/or statutory filing.
      properties:
        key:
          type: string
          description: Machine-readable field identifier, unique within a jurisdiction
          example: taxId
        name:
          type: string
          description: Human-readable field label, suitable for form rendering
          example: RFC (Registro Federal de Contribuyentes)
        description:
          type: string
          description: What this field is used for, with legislative context where relevant
          example: SAT-issued RFC, required on all ISR withholding returns
        type:
          type: string
          enum:
            - string
            - number
            - boolean
            - date
            - document
          description: |
            Data type of the field value. For `document` fields the value is a
            `fileId`: request an upload URL with `POST /v1/files/upload-url`
            (Workforce Management API, purpose `statutory-document`), HTTP PUT
            the file bytes to the returned `putUrl`, then submit the `fileId`
            as the field value. GET responses return document fields as an
            object with a presigned download `url`.
          example: string
        required:
          type: boolean
          description: >-
            Whether the field is mandatory. Conditional fields may be required
            only when their condition is met.
          example: true
        entity:
          type: string
          enum:
            - person
            - business
          description: |
            Who this field belongs to:
            - `person` — Worker-level data. Submit filing-scoped fields via
              `PUT /v1/statutory/persons/{id}/fields/{countryCode}`.
            - `business` — Employer-level data. Submit filing-scoped fields via
              `PUT /v1/statutory/businesses/{id}/fields/{countryCode}`.
          example: person
        scope:
          type: array
          items:
            type: string
            enum:
              - calculation
              - filing
          description: >
            What this field is used for:

            - `calculation` — Required by the tax engine for gross-to-net
            computation.
              Submit via `PUT /v1/persons/{id}/taxProfile`.
            - `filing` — Required on the statutory return submitted to the
            authority.
              Submit via the statutory fields endpoints.
            A field can appear in both scopes — submit to both endpoints.
          example:
            - calculation
            - filing
        enum:
          type: array
          items:
            type: string
          description: Allowed values, when the field accepts a fixed set of options
        pattern:
          type: string
          description: Regex pattern for string validation
          example: ^[A-Z&Ñ]{4}\d{6}[A-Z0-9]{3}$
        condition:
          $ref: '#/components/schemas/FieldCondition'
      required:
        - key
        - name
        - description
        - type
        - required
        - entity
        - scope
    FieldCondition:
      type: object
      description: |
        Conditional applicability — this field is only required when another
        field or person attribute matches a specific value. For example,
        a pension PIN is only required when the worker's `is_pensionable`
        flag is true.
      properties:
        field:
          type: string
          description: The key of another field or person attribute to check
          example: is_pensionable
        equals:
          description: The value that triggers this field's requirement
          example: true
      required:
        - field
        - equals
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````