> ## 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 compliance health summary

> **Beta** — contact Cadana to enable access for your business.

**Not yet implemented.**

Returns a single-call overview of the business's entire statutory
compliance posture across all jurisdictions. Includes filing counts by
status, remittance totals, upcoming deadlines, and outstanding
requirements.

This is the "how are we doing?" endpoint — designed to power compliance
dashboards without needing multiple API calls.




## OpenAPI

````yaml /openapi/statutory-compliance.yaml get /v1/statutory/compliance/summary
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/compliance/summary:
    get:
      tags:
        - Filings
      summary: Get compliance health summary
      description: |
        **Beta** — contact Cadana to enable access for your business.

        **Not yet implemented.**

        Returns a single-call overview of the business's entire statutory
        compliance posture across all jurisdictions. Includes filing counts by
        status, remittance totals, upcoming deadlines, and outstanding
        requirements.

        This is the "how are we doing?" endpoint — designed to power compliance
        dashboards without needing multiple API calls.
      operationId: getComplianceSummary
      parameters:
        - $ref: '#/components/parameters/XMultiTenantKey'
        - name: businessId
          in: query
          required: true
          schema:
            type: string
        - name: countryCode
          in: query
          schema:
            type: string
          description: Filter to a specific jurisdiction
      responses:
        '200':
          description: Compliance health summary
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComplianceSummary'
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.
  schemas:
    ComplianceSummary:
      type: object
      description: Single-call compliance health overview
      properties:
        businessId:
          type: string
        asOf:
          type: string
          format: date-time
          description: Timestamp of this summary
        filings:
          type: object
          properties:
            total:
              type: integer
            byStatus:
              type: object
              properties:
                pending:
                  type: integer
                blocked:
                  type: integer
                in_review:
                  type: integer
                approved:
                  type: integer
                submitted:
                  type: integer
                accepted:
                  type: integer
                rejected:
                  type: integer
        remittances:
          type: object
          properties:
            pendingCount:
              type: integer
            pendingAmount:
              type: number
              format: decimal
              description: Total amount awaiting remittance (in USD equivalent)
            completedThisMonth:
              type: integer
            completedAmountThisMonth:
              type: number
              format: decimal
        requirements:
          type: object
          properties:
            outstanding:
              type: integer
            byCategory:
              type: object
              properties:
                businessRegistration:
                  type: integer
                businessDocument:
                  type: integer
                businessTaxParameter:
                  type: integer
                workerData:
                  type: integer
        nextDeadlines:
          type: array
          description: Next 5 upcoming deadlines across all jurisdictions
          items:
            type: object
            properties:
              filingId:
                type: string
              filingTypeName:
                type: string
              countryCode:
                type: string
              dueAt:
                type: string
                format: date-time
              status:
                type: string
        jurisdictions:
          type: array
          description: Per-country breakdown
          items:
            type: object
            properties:
              countryCode:
                type: string
              countryName:
                type: string
              workerCount:
                type: integer
              filingsCompleted:
                type: integer
              filingsTotal:
                type: integer
              requirementsOutstanding:
                type: integer
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: API_SECRET_KEY

````