Skip to content

Get a registration

The registrations.get operation: GET /api/v1/registrations/{id} in the REST API and the registrations_get tool in the MCP server.

GET/api/v1/registrations/{id}

Returns one registration of the legal entity in the mode of the request, by its ID (regn_…) or its regime's ID (EU_OSS_UNION, US_SALES_TAX:TX): everything needed to act on it (spec §10.6).

  • state, stateReason, armed, the grace deadlineAt and autoBlockAt, escalationLevel;
  • threshold (the position of the counters, all brands combined) and counters (per window);
  • prerequisites with their description and lead time from the regime, status, notes, owner and attachments;
  • regime (its rules from the tax knowledge), playbooks (markdown) and officialLinks;
  • actions: which of arm, mark application submitted, mark registered and deregister the registration allows now, and for each one it doesn't the error code and message it would return;
  • history (every state change, who made it and why).

Playbooks and remediation texts are platform-maintained guidance; every other text field is data.

At a glance

  • REST: GET /api/v1/registrations/{id}
  • MCP tool: registrations_get
  • Operation ID: registrations.get
  • Scope: Legal entity
  • 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: M3

Request

Path parameters

FieldTypeDescription
idstringThe registration (regn_…) or its regime's ID, e.g. EU_OSS_UNION or US_SALES_TAX:TX.

Query parameters

This operation takes no query parameters.

Response

200 OK with a JSON object:

FieldTypeDescription
idregn_… ID
object"registration"
entityIdent_… ID
livemodeboolean
regimeIdstring
regimeNamestring or null
jurisdictionIdsarray of string
stateone of not_applicable, monitored, pre_registration, grace, registered, blocked_b2c, deregistered
stateReasonone of 18 values, e.g. home_country, below_threshold, zero_threshold (all in the OpenAPI document)
stateChangedAtdate-time
armedboolean
triggeredAtdate-time or null
deadlineAtdate-time or null
autoBlockAtdate-time or null
applicationSubmittedAtdate-time or null
escalationLevelinteger (0 to 3)
registrationNumberstring or null
effectiveFromdate-time or null
registeredAtdate-time or null
prerequisitesDoneboolean
prerequisitesProgressobject
prerequisitesProgress.doneinteger
prerequisitesProgress.totalinteger
thresholdobject or null
timeZonesarray of string
createdAtdate-time
updatedAtdate-time
prerequisitesarray of object
prerequisites[].codestring
prerequisites[].descriptionstring or null
prerequisites[].leadTimeDaysinteger or null
prerequisites[].statusone of todo, in_progress, done
prerequisites[].doneAtdate-time or null
prerequisites[].notesstring
prerequisites[].ownerstring or null
prerequisites[].attachmentsarray of object
prerequisites[].attachments[].kindone of file, reference
prerequisites[].attachments[].refstring
prerequisites[].attachments[].labelstring or null
prerequisites[].attachments[].addedAtdate-time
prerequisites[].attachments[].addedBystring
prerequisites[].updatedAtdate-time or null
prerequisites[].updatedBystring or null
evidenceFilesarray of object
evidenceFiles[].kindone of file, reference
evidenceFiles[].refstring
evidenceFiles[].labelstring or null
evidenceFiles[].addedAtdate-time
evidenceFiles[].addedBystring
historyarray of object
history[].fromone of not_applicable, monitored, pre_registration, grace, registered, blocked_b2c, deregistered or null
history[].toone of not_applicable, monitored, pre_registration, grace, registered, blocked_b2c, deregistered
history[].atdate-time
history[].bystring
history[].reasonone of 18 values, e.g. home_country, below_threshold, zero_threshold (all in the OpenAPI document)
history[].notestring or null
countersarray of object
counters[].windowKeystring
counters[].amountmoney
counters[].transactionCountinteger
counters[].lastEventAtdate-time
regimeobject or null
playbooksarray of object
playbooks[].keystring
playbooks[].kindone of registration, filing, deregistration, other
playbooks[].markdownstring
officialLinksarray of object
officialLinks[].labelstring
officialLinks[].urlstring
actionsobject
actions.armobject
actions.arm.allowedboolean
actions.arm.codestring or null
actions.arm.messagestring or null
actions.markApplicationSubmittedobject
actions.markApplicationSubmitted.allowedboolean
actions.markApplicationSubmitted.codestring or null
actions.markApplicationSubmitted.messagestring or null
actions.markRegisteredobject
actions.markRegistered.allowedboolean
actions.markRegistered.codestring or null
actions.markRegistered.messagestring or null
actions.deregisterobject
actions.deregister.allowedboolean
actions.deregister.codestring or null
actions.deregister.messagestring or null
safetyBufferHoursinteger
knowledgeCommitstring

Examples

EU OSS at the pre-registration level

HTTP
GET /api/v1/registrations/EU_OSS_UNION
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "id": "regn_01m4tx5nj8emwbyf7y9vcf47xk",
  "object": "registration",
  "entityId": "ent_01m4tx5nj8emwbyf7y9vcf47x2",
  "livemode": true,
  "regimeId": "EU_OSS_UNION",
  "regimeName": "EU One-Stop Shop, Union scheme",
  "jurisdictionIds": ["AT", "DE", "FR", "HR", "IT", "NL"],
  "state": "pre_registration",
  "stateReason": "pre_registration_ratio_reached",
  "stateChangedAt": "2026-10-13T12:00:00.000Z",
  "armed": false,
  "triggeredAt": null,
  "deadlineAt": null,
  "autoBlockAt": null,
  "applicationSubmittedAt": null,
  "escalationLevel": 0,
  "registrationNumber": null,
  "effectiveFrom": null,
  "registeredAt": null,
  "prerequisitesDone": true,
  "prerequisitesProgress": {
    "done": 1,
    "total": 1
  },
  "threshold": {
    "status": "below",
    "window": "calendar_year_current_or_previous",
    "measure": "eu_cross_border_b2c",
    "currentWindow": "2026",
    "previousWindow": "2025",
    "threshold": {
      "amount": "10000000000",
      "currency": "EUR"
    },
    "current": {
      "amount": "8500000000",
      "currency": "EUR"
    },
    "previous": {
      "amount": "0",
      "currency": "EUR"
    },
    "transactionThreshold": null,
    "currentTransactions": null,
    "previousTransactions": null,
    "worldwideTurnoverDeclared": null,
    "ratioPpm": "850000",
    "percent": 85,
    "detail": "8500.00 EUR counted (earlier window 0.00) against 10000.00 EUR"
  },
  "timeZones": ["Europe/Zagreb"],
  "createdAt": "2026-10-13T12:00:00.000Z",
  "updatedAt": "2026-10-13T12:00:00.000Z",
  "prerequisites": [
    {
      "code": "portal_access",
      "description": "Access to the tax portal of the member state of identification",
      "leadTimeDays": 7,
      "status": "done",
      "doneAt": "2026-10-13T12:00:00.000Z",
      "notes": "ePorezna access for the finance team",
      "owner": "Ana (finance)",
      "attachments": [],
      "updatedAt": "2026-10-13T12:00:00.000Z",
      "updatedBy": "usr_01m4tx5nj8emwbyf7y9vcf47xa"
    }
  ],
  "evidenceFiles": [],
  "history": [
    {
      "from": null,
      "to": "monitored",
      "at": "2026-10-13T12:00:00.000Z",
      "by": "system",
      "reason": "below_threshold",
      "note": null
    },
    {
      "from": "monitored",
      "to": "pre_registration",
      "at": "2026-10-13T12:00:00.000Z",
      "by": "system",
      "reason": "pre_registration_ratio_reached",
      "note": null
    }
  ],
  "counters": [
    {
      "windowKey": "2026",
      "amount": {
        "amount": "8500000000",
        "currency": "EUR"
      },
      "transactionCount": 412,
      "lastEventAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "regime": {
    "id": "EU_OSS_UNION",
    "name": "EU One-Stop Shop, Union scheme",
    "version": "3f2a9c41d07e88b1",
    "jurisdictionIds": ["AT", "DE", "FR", "HR", "IT", "NL"],
    "sellerEstablishment": "in_eu_other_ms",
    "customerType": "b2c",
    "threshold": {
      "amount": {
        "amount": "10000000000",
        "currency": "EUR"
      },
      "measure": "eu_cross_border_b2c",
      "window": "calendar_year_current_or_previous",
      "transactionCount": null,
      "whatCounts": "B2C electronically supplied services to consumers in other member states, net of VAT.",
      "amountInclusive": false
    },
    "zeroThreshold": false,
    "grace": {
      "rule": "nth_day_of_following_month",
      "days": null,
      "nthDay": 10
    },
    "collectBeforeRegistration": true,
    "b2bReverseChargeNoRegistration": true,
    "b2bChargeWhenRegistered": false,
    "requiresFiscalRepresentative": false,
    "requiresLocalAgent": false,
    "securityDeposit": null,
    "registration": {
      "method": "online",
      "portalUrl": "https://e-porezna.porezna-uprava.hr",
      "identityRequirements": null,
      "typicalProcessingDays": 7
    },
    "status": "verified",
    "unverified": false,
    "fixture": false,
    "validFrom": "2021-07-01",
    "validTo": null
  },
  "playbooks": [
    {
      "key": "EU/playbooks/EU_OSS_UNION-registration.md",
      "kind": "registration",
      "markdown": "# Registering for the Union OSS\n\n1. Sign in to the portal of your member state …"
    }
  ],
  "officialLinks": [
    {
      "label": "EU One-Stop Shop, Union scheme: registration portal",
      "url": "https://e-porezna.porezna-uprava.hr"
    }
  ],
  "actions": {
    "arm": {
      "allowed": false,
      "code": "registration_transition_invalid",
      "message": "EU_OSS_UNION is pre_registration, so \"arm\" isn't possible."
    },
    "markApplicationSubmitted": {
      "allowed": false,
      "code": "registration_transition_invalid",
      "message": "EU_OSS_UNION is pre_registration, so \"application_submitted\" isn't possible."
    },
    "markRegistered": {
      "allowed": true,
      "code": null,
      "message": null
    },
    "deregister": {
      "allowed": false,
      "code": "registration_transition_invalid",
      "message": "EU_OSS_UNION is pre_registration, so \"deregister\" isn't possible."
    }
  },
  "safetyBufferHours": 72,
  "knowledgeCommit": "1c14b2ec912aca347dd518b2044096f3b5d8eef1"
}

A registration in grace, by its ID

HTTP
GET /api/v1/registrations/regn_01m4tx5nj8emwbyf7y9vcf47xk
Authorization: Bearer or_test_…

Response (200):

JSON
{
  "id": "regn_01m4tx5nj8emwbyf7y9vcf47xk",
  "object": "registration",
  "entityId": "ent_01m4tx5nj8emwbyf7y9vcf47x2",
  "livemode": true,
  "regimeId": "EU_OSS_UNION",
  "regimeName": "EU One-Stop Shop, Union scheme",
  "jurisdictionIds": ["AT", "DE", "FR", "HR", "IT", "NL"],
  "state": "grace",
  "stateReason": "threshold_crossed",
  "stateChangedAt": "2026-10-14T09:30:00.000Z",
  "armed": false,
  "triggeredAt": "2026-10-14T09:30:00.000Z",
  "deadlineAt": "2026-11-10T22:59:59.000Z",
  "autoBlockAt": "2026-11-07T22:59:59.000Z",
  "applicationSubmittedAt": null,
  "escalationLevel": 0,
  "registrationNumber": null,
  "effectiveFrom": null,
  "registeredAt": null,
  "prerequisitesDone": true,
  "prerequisitesProgress": {
    "done": 1,
    "total": 1
  },
  "threshold": {
    "status": "over",
    "window": "calendar_year_current_or_previous",
    "measure": "eu_cross_border_b2c",
    "currentWindow": "2026",
    "previousWindow": "2025",
    "threshold": {
      "amount": "10000000000",
      "currency": "EUR"
    },
    "current": {
      "amount": "8500000000",
      "currency": "EUR"
    },
    "previous": {
      "amount": "0",
      "currency": "EUR"
    },
    "transactionThreshold": null,
    "currentTransactions": null,
    "previousTransactions": null,
    "worldwideTurnoverDeclared": null,
    "ratioPpm": "1004500",
    "percent": 100,
    "detail": "8500.00 EUR counted (earlier window 0.00) against 10000.00 EUR"
  },
  "timeZones": ["Europe/Zagreb"],
  "createdAt": "2026-10-13T12:00:00.000Z",
  "updatedAt": "2026-10-14T09:30:00.000Z",
  "prerequisites": [
    {
      "code": "portal_access",
      "description": "Access to the tax portal of the member state of identification",
      "leadTimeDays": 7,
      "status": "done",
      "doneAt": "2026-10-13T12:00:00.000Z",
      "notes": "ePorezna access for the finance team",
      "owner": "Ana (finance)",
      "attachments": [],
      "updatedAt": "2026-10-13T12:00:00.000Z",
      "updatedBy": "usr_01m4tx5nj8emwbyf7y9vcf47xa"
    }
  ],
  "evidenceFiles": [],
  "history": [
    {
      "from": null,
      "to": "monitored",
      "at": "2026-10-13T12:00:00.000Z",
      "by": "system",
      "reason": "below_threshold",
      "note": null
    },
    {
      "from": "monitored",
      "to": "pre_registration",
      "at": "2026-10-13T12:00:00.000Z",
      "by": "system",
      "reason": "pre_registration_ratio_reached",
      "note": null
    }
  ],
  "counters": [
    {
      "windowKey": "2026",
      "amount": {
        "amount": "8500000000",
        "currency": "EUR"
      },
      "transactionCount": 412,
      "lastEventAt": "2026-10-13T12:00:00.000Z"
    }
  ],
  "regime": {
    "id": "EU_OSS_UNION",
    "name": "EU One-Stop Shop, Union scheme",
    "version": "3f2a9c41d07e88b1",
    "jurisdictionIds": ["AT", "DE", "FR", "HR", "IT", "NL"],
    "sellerEstablishment": "in_eu_other_ms",
    "customerType": "b2c",
    "threshold": {
      "amount": {
        "amount": "10000000000",
        "currency": "EUR"
      },
      "measure": "eu_cross_border_b2c",
      "window": "calendar_year_current_or_previous",
      "transactionCount": null,
      "whatCounts": "B2C electronically supplied services to consumers in other member states, net of VAT.",
      "amountInclusive": false
    },
    "zeroThreshold": false,
    "grace": {
      "rule": "nth_day_of_following_month",
      "days": null,
      "nthDay": 10
    },
    "collectBeforeRegistration": true,
    "b2bReverseChargeNoRegistration": true,
    "b2bChargeWhenRegistered": false,
    "requiresFiscalRepresentative": false,
    "requiresLocalAgent": false,
    "securityDeposit": null,
    "registration": {
      "method": "online",
      "portalUrl": "https://e-porezna.porezna-uprava.hr",
      "identityRequirements": null,
      "typicalProcessingDays": 7
    },
    "status": "verified",
    "unverified": false,
    "fixture": false,
    "validFrom": "2021-07-01",
    "validTo": null
  },
  "playbooks": [
    {
      "key": "EU/playbooks/EU_OSS_UNION-registration.md",
      "kind": "registration",
      "markdown": "# Registering for the Union OSS\n\n1. Sign in to the portal of your member state …"
    }
  ],
  "officialLinks": [
    {
      "label": "EU One-Stop Shop, Union scheme: registration portal",
      "url": "https://e-porezna.porezna-uprava.hr"
    }
  ],
  "actions": {
    "arm": {
      "allowed": false,
      "code": "registration_transition_invalid",
      "message": "EU_OSS_UNION is grace, so \"arm\" isn't possible."
    },
    "markApplicationSubmitted": {
      "allowed": true,
      "code": null,
      "message": null
    },
    "markRegistered": {
      "allowed": true,
      "code": null,
      "message": null
    },
    "deregister": {
      "allowed": false,
      "code": "registration_transition_invalid",
      "message": "EU_OSS_UNION is grace, so \"deregister\" isn't possible."
    }
  },
  "safetyBufferHours": 72,
  "knowledgeCommit": "1c14b2ec912aca347dd518b2044096f3b5d8eef1"
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400id is neither a registration ID nor a regime ID.Fix the fields listed in details.issues and send the request again.
resource_not_found404This entity has no such registration in this mode.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
scope_required400The request names no legal entity (an org key without Ownrecord-Entity).Call the operation with credentials or a target at its level: an organization, a legal entity, a brand or the platform (details.required_scope).
permission_denied403You can't see this entity's registrations (brand-scoped members never can).Ask an organization owner or admin for a role or scope that allows this action.

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