Skip to content

Update an authorization

The authorizations.update operation: PATCH /api/v1/authorizations/{id} in the REST API and the authorizations_update tool in the MCP server.

PATCH/api/v1/authorizations/{id}

Changes an authorization: the regimes and portals it covers, its validity (extend validTo, or null for open-ended), its document (null removes it), the holder's details or the non-secret access notes. A revoked authorization doesn't change (authorization_status_invalid); record a new one. Never store credentials (authorization_secret_refused).

Compliance tier (spec §41.4): an agent's call needs approval under the default policy.

At a glance

  • REST: PATCH /api/v1/authorizations/{id}
  • MCP tool: authorizations_update
  • Operation ID: authorizations.update
  • Scope: Legal entity
  • Permission: tasks:write
  • Risk tier: compliance
  • Dry run: Supported (send Ownrecord-Dry-Run: true)
  • Idempotency: Idempotency-Key optional
  • Modes: Test and live
  • Authentication: API key with the tasks:write scope
  • Since: M10

Request

Path parameters

FieldTypeDescription
idatz_… ID

Body

A JSON object (Content-Type: application/json):

FieldTypeRequiredDescription
regimeIdsarray of stringNoThe regimes it covers, e.g. EU_OSS_UNION.
holderobjectNoWho may act: a person, a firm, or an installed app.
holder.typeone of person, firm, appYes
holder.namestringYes
holder.contactstringNo
holder.appInstallationIdains_… IDNo
kindone of employee_eid, power_of_attorney, tax_representative, fiscal_representative, api_oauthNoThe kind of authority.
documentFileIdfile_… ID or nullNo
validFromdate-timeNoFrom when it is valid (ISO 8601).
validTodate-time or nullNo
portalsarray of stringNoThe tax portals it covers (names or URLs).
accessNotesobject or nullNo
expectedVersioninteger (at least 1)No

Response

200 OK with a JSON object:

FieldTypeDescription
idatz_… ID
object"authorization"
entityIdent_… ID
livemodeboolean
regimeIdsarray of string
holderobject
holder.typeone of person, firm, app
holder.namestring
holder.contactstring or null
holder.appInstallationIdains_… ID or null
kindone of employee_eid, power_of_attorney, tax_representative, fiscal_representative, api_oauth
documentFileIdfile_… ID or null
validFromdate-time
validTodate-time or null
portalsarray of string
accessNotesobject or null
statusone of active, expired, revoked, not_yet_valid
revokedAtdate-time or null
revocationReasonstring or null
createdAtdate-time
updatedAtdate-time
versioninteger (at least 1)

Examples

Extend it by a year

HTTP
PATCH /api/v1/authorizations/atz_01m4ttwd3veh9apbewxheq5xa3
Authorization: Bearer or_test_…
Content-Type: application/json

{
  "validTo": "2028-12-31T23:00:00.000Z",
  "expectedVersion": 1
}

Response (200):

JSON
{
  "id": "atz_01m4ttwd3veh9apbewxheq5xa3",
  "object": "authorization",
  "entityId": "ent_01m4ttwd3veh9apbewxheq5xh4",
  "livemode": true,
  "regimeIds": ["EU_OSS_UNION"],
  "holder": {
    "type": "person",
    "name": "Ana Horvat",
    "contact": "ana.horvat@example.com",
    "appInstallationId": null
  },
  "kind": "employee_eid",
  "documentFileId": null,
  "validFrom": "2026-01-01T00:00:00.000Z",
  "validTo": "2028-12-31T23:00:00.000Z",
  "portals": ["Croatian Tax Administration OSS portal (ePorezna)"],
  "accessNotes": {
    "method": "eid",
    "renewalDueAt": "2027-11-30T23:00:00.000Z",
    "notes": "Ana signs in with her personal eID card."
  },
  "status": "active",
  "revokedAt": null,
  "revocationReason": null,
  "createdAt": "2026-01-05T10:00:00.000Z",
  "updatedAt": "2026-11-08T09:15:00.000Z",
  "version": 2
}

Errors

CodeHTTP statusWhenWhat to do
validation_failed400A field is malformed, or validTo isn't after validFrom.Fix the fields listed in details.issues and send the request again.
authorization_secret_refused400A text field looks like a credential (param names it).Keep passwords, PINs, eIDs and certificates in your own vault. Record only non-secret notes: the access method, who holds access and the renewal date. param names the field.
authorization_document_not_found400documentFileId isn't an authorization document of this entity.Upload the signed document with authorizations.documents.upload and pass its file_… ID as documentFileId.
scope_required400The request names no legal 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 manage this entity's tasks and authorizations.Ask an organization owner or admin for a role or scope that allows this action.
resource_not_found404No authorization with this ID for this entity in this mode.Check the ID and that your credentials are scoped to the right organization, entity, brand and mode.
authorization_status_invalid409The authorization is revoked.A revoked authorization doesn't change. Record a new one with authorizations.create.
version_conflict409It changed since expectedVersion, or at the same moment.Fetch the object again and retry the change.

It can also return these common errors: api_version_unsupported, invalid_json, unsupported_media_type, authentication_required, api_key_invalid, idempotency_key_reused, idempotency_in_progress, approval_required, approval_rejected, approval_expired, stale_approval, approval_policy_denied, rate_limited, internal_error.