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.

GET /v1/statutory/compliance/summary

Get compliance health summary

cURL

curl --request GET \
  --url https://api.cadanapay.com/v1/statutory/compliance/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.cadanapay.com/v1/statutory/compliance/summary"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.cadanapay.com/v1/statutory/compliance/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cadanapay.com/v1/statutory/compliance/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cadanapay.com/v1/statutory/compliance/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cadanapay.com/v1/statutory/compliance/summary")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cadanapay.com/v1/statutory/compliance/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "businessId": "<string>",
  "asOf": "2023-11-07T05:31:56Z",
  "filings": {
    "total": 123,
    "byStatus": {
      "pending": 123,
      "blocked": 123,
      "in_review": 123,
      "approved": 123,
      "submitted": 123,
      "accepted": 123,
      "rejected": 123
    }
  },
  "remittances": {
    "pendingCount": 123,
    "pendingAmount": 123,
    "completedThisMonth": 123,
    "completedAmountThisMonth": 123
  },
  "requirements": {
    "outstanding": 123,
    "byCategory": {
      "businessRegistration": 123,
      "businessDocument": 123,
      "businessTaxParameter": 123,
      "workerData": 123
    }
  },
  "nextDeadlines": [
    {
      "filingId": "<string>",
      "filingTypeName": "<string>",
      "countryCode": "<string>",
      "dueAt": "2023-11-07T05:31:56Z",
      "status": "<string>"
    }
  ],
  "jurisdictions": [
    {
      "countryCode": "<string>",
      "countryName": "<string>",
      "workerCount": 123,
      "filingsCompleted": 123,
      "filingsTotal": 123,
      "requirementsOutstanding": 123
    }
  ]
}

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.

Query Parameters

businessId · string · required

countryCode · string

Filter to a specific jurisdiction

Response

200 - application/json

Compliance health summary

Single-call compliance health overview

businessId · string

asOf · string<date-time>

Timestamp of this summary

filings · object

Show child attributes

remittances · object

Show child attributes

requirements · object

Show child attributes

nextDeadlines · object[]

Next 5 upcoming deadlines across all jurisdictions

Show child attributes

jurisdictions · object[]

Per-country breakdown

Show child attributes