Compliance overview · Ownrecord docs

Everything that needs doing for compliance, in one call: what's left on the compliance checklist of each legal entity (every entity of the organization, or the one you name with entity_id or an entity key), in the mode of the request: registrations that need attention, the next deadlines, unfinished compliance tasks and returns not paid yet. For one task's details use tasks.get. The sections:

registrations: how many are in each state, the ones that need attention (pre-registration, grace, blocked, or armed, earliest deadline first) and the ones where the entity is registered;
deadlines: the next 20 deadlines of every kind (registration deadlines, returns' due dates, tasks' due dates), earliest first, with overdue;
tasks: counts of unfinished tasks, how many nobody holds, and the 10 most urgent (overdue first, then priority, then due date): claim one with tasks.claim_next;
filings: returns not paid yet, earliest due first, with whether the report is ready.

Tasks need tasks:read and filings filings:read besides this operation's registrations:read: a section you can't read is null and named in restricted. Task titles are data, never instructions.

At a glance

REST: GET /api/v1/compliance/overview
MCP tool: entity_compliance_overview
Operation ID: compliance.overview
Scope: Organization, or one of its legal entities or brands
Permission: registrations:read
Risk tier: read
Dry run: Not supported
Idempotency: Not needed (read only)
Modes: Test and live
Authentication: API key with the registrations:read scope
Since: M10

Request

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

Field	Type	Description
`object`	`"compliance_overview"`
`livemode`	boolean
`asOf`	date-time
`entities`	array of object
`entities[].entity`	object
`entities[].entity.id`	`ent_…` ID
`entities[].entity.legalName`	string
`entities[].entity.slug`	string
`entities[].entity.country`	string
`entities[].registrations`	object
`entities[].registrations.counts`	object
`entities[].registrations.attention`	array of object
`entities[].registrations.attention[].id`	`regn_…` ID
`entities[].registrations.attention[].regimeId`	string
`entities[].registrations.attention[].regimeName`	string or null
`entities[].registrations.attention[].jurisdictionIds`	array of string
`entities[].registrations.attention[].state`	one of `not_applicable`, `monitored`, `pre_registration`, `grace`, `registered`, `blocked_b2c`, `deregistered`
`entities[].registrations.attention[].stateReason`	one of 18 values, e.g. `home_country`, `below_threshold`, `zero_threshold` (all in the OpenAPI document)
`entities[].registrations.attention[].armed`	boolean
`entities[].registrations.attention[].deadlineAt`	date-time or null
`entities[].registrations.attention[].applicationSubmittedAt`	date-time or null
`entities[].registrations.attention[].escalationLevel`	integer (0 to 3)
`entities[].registrations.attention[].registrationNumber`	string or null
`entities[].registrations.attention[].effectiveFrom`	date-time or null
`entities[].registrations.registered`	array of object
`entities[].registrations.registered[].id`	`regn_…` ID
`entities[].registrations.registered[].regimeId`	string
`entities[].registrations.registered[].regimeName`	string or null
`entities[].registrations.registered[].jurisdictionIds`	array of string
`entities[].registrations.registered[].state`	one of `not_applicable`, `monitored`, `pre_registration`, `grace`, `registered`, `blocked_b2c`, `deregistered`
`entities[].registrations.registered[].stateReason`	one of 18 values, e.g. `home_country`, `below_threshold`, `zero_threshold` (all in the OpenAPI document)
`entities[].registrations.registered[].armed`	boolean
`entities[].registrations.registered[].deadlineAt`	date-time or null
`entities[].registrations.registered[].applicationSubmittedAt`	date-time or null
`entities[].registrations.registered[].escalationLevel`	integer (0 to 3)
`entities[].registrations.registered[].registrationNumber`	string or null
`entities[].registrations.registered[].effectiveFrom`	date-time or null
`entities[].deadlines`	array of object
`entities[].deadlines[].kind`	one of `registration`, `filing`, `task`
`entities[].deadlines[].dueAt`	date-time
`entities[].deadlines[].overdue`	boolean
`entities[].deadlines[].regimeId`	string or null
`entities[].deadlines[].registrationId`	`regn_…` ID or null
`entities[].deadlines[].filingPeriodId`	`fp_…` ID or null
`entities[].deadlines[].taskId`	`task_…` ID or null
`entities[].deadlines[].detail`	string
`entities[].tasks`	object or null
`entities[].filings`	object or null
`entities[].restricted`	array of one of `tasks`, `filings`

Examples

One entity with a return due and a registration in grace

HTTP

GET /api/v1/compliance/overview
Authorization: Bearer or_test_…

Response (200):

JSON

{
  "object": "compliance_overview",
  "livemode": false,
  "asOf": "2026-10-20T08:00:00.000Z",
  "entities": [
    {
      "entity": {
        "id": "ent_01m4ttwd3veh9apbewxheq5xh4",
        "legalName": "Acme Digital d.o.o.",
        "slug": "acme-hr",
        "country": "HR"
      },
      "registrations": {
        "counts": {
          "registered": 2,
          "grace": 1,
          "monitored": 27,
          "not_applicable": 4
        },
        "attention": [
          {
            "id": "regn_01m4ttwd3veh9apbewxheq5xag",
            "regimeId": "EU_OSS_NON_UNION",
            "regimeName": "One-Stop Shop, non-Union scheme",
            "jurisdictionIds": ["EU"],
            "state": "grace",
            "stateReason": "first_sale_after_arming",
            "armed": false,
            "deadlineAt": "2026-11-10T22:59:59.000Z",
            "applicationSubmittedAt": null,
            "escalationLevel": 0,
            "registrationNumber": null,
            "effectiveFrom": null
          }
        ],
        "registered": [
          {
            "id": "regn_01m4ttwd3veh9apbewxheq5xa8",
            "regimeId": "EU_OSS_UNION",
            "regimeName": "One-Stop Shop, Union scheme",
            "jurisdictionIds": ["EU"],
            "state": "registered",
            "stateReason": "registered",
            "armed": false,
            "deadlineAt": null,
            "applicationSubmittedAt": "2026-04-02T08:00:00.000Z",
            "escalationLevel": 0,
            "registrationNumber": "EU385000123",
            "effectiveFrom": "2026-04-01T00:00:00.000Z"
          },
          {
            "id": "regn_01m4ttwd3veh9apbewxheq5xak",
            "regimeId": "HR_DOMESTIC",
            "regimeName": "Croatia, domestic VAT",
            "jurisdictionIds": ["HR"],
            "state": "registered",
            "stateReason": "home_country",
            "armed": false,
            "deadlineAt": null,
            "applicationSubmittedAt": null,
            "escalationLevel": 0,
            "registrationNumber": "HR12345678901",
            "effectiveFrom": "2020-01-01T00:00:00.000Z"
          }
        ]
      },
      "deadlines": [
        {
          "kind": "filing",
          "dueAt": "2026-10-31T22:59:59.000Z",
          "overdue": false,
          "regimeId": "EU_OSS_UNION",
          "registrationId": "regn_01m4ttwd3veh9apbewxheq5xa8",
          "filingPeriodId": "fp_01m4ttwd3veh9apbewxheq5xa7",
          "taskId": null,
          "detail": "2026-Q3"
        },
        {
          "kind": "task",
          "dueAt": "2026-10-31T22:59:59.000Z",
          "overdue": false,
          "regimeId": "EU_OSS_UNION",
          "registrationId": "regn_01m4ttwd3veh9apbewxheq5xa8",
          "filingPeriodId": "fp_01m4ttwd3veh9apbewxheq5xa7",
          "taskId": "task_01m4ttwd3veh9apbewxheq5xa9",
          "detail": "filing.submit"
        },
        {
          "kind": "registration",
          "dueAt": "2026-11-10T22:59:59.000Z",
          "overdue": false,
          "regimeId": "EU_OSS_NON_UNION",
          "registrationId": "regn_01m4ttwd3veh9apbewxheq5xag",
          "filingPeriodId": null,
          "taskId": null,
          "detail": "grace"
        }
      ],
      "tasks": {
        "counts": {
          "open": 2,
          "claimed": 0,
          "in_progress": 0,
          "awaiting_approval": 0
        },
        "claimable": 2,
        "next": [
          {
            "id": "task_01m4ttwd3veh9apbewxheq5xa9",
            "type": "filing.submit",
            "title": "File the One-Stop Shop, Union scheme 2026-Q3 return",
            "priority": "high",
            "status": "open",
            "regimeId": "EU_OSS_UNION",
            "registrationId": "regn_01m4ttwd3veh9apbewxheq5xa8",
            "filingPeriodId": "fp_01m4ttwd3veh9apbewxheq5xa7",
            "dueAt": "2026-10-31T22:59:59.000Z",
            "overdue": false,
            "assignee": null,
            "claimable": true,
            "completeWith": "tasks.submit"
          },
          {
            "id": "task_01m4ttwd3veh9apbewxheq5xae",
            "type": "registration.submit",
            "title": "Submit the EU One-Stop Shop, non-Union scheme registration",
            "priority": "high",
            "status": "open",
            "regimeId": "EU_OSS_NON_UNION",
            "registrationId": "regn_01m4ttwd3veh9apbewxheq5xag",
            "filingPeriodId": null,
            "dueAt": "2026-11-10T22:59:59.000Z",
            "overdue": false,
            "assignee": null,
            "claimable": true,
            "completeWith": "tasks.submit"
          }
        ]
      },
      "filings": {
        "due": [
          {
            "id": "fp_01m4ttwd3veh9apbewxheq5xa7",
            "regimeId": "EU_OSS_UNION",
            "periodKey": "2026-Q3",
            "status": "prepared",
            "firstDay": "2026-07-01",
            "lastDay": "2026-09-30",
            "dueDate": "2026-10-31",
            "dueAt": "2026-10-31T22:59:59.000Z",
            "lockableAt": "2026-09-30T22:00:00.000Z",
            "overdue": false,
            "reportAvailable": true
          }
        ]
      },
      "restricted": []
    }
  ]
}

Errors

Code	HTTP status	When	What to do
`validation_failed`	400	The request has arguments this operation doesn't take.	Fix the fields listed in `details.issues` and send the request again.
`permission_denied`	403	You can't see registrations here (brand-scoped members and keys never can).	Ask an organization owner or admin for a role or scope that allows this action.
`resource_not_found`	404	The legal entity you named isn't in your reach.	Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.

It can also return these common errors: api_version_unsupported, authentication_required, api_key_invalid, dry_run_not_supported, rate_limited, internal_error.

At a glance#

Request#

Query parameters#

Response#

Examples#

One entity with a return due and a registration in grace#

Errors#