Client - Agent Authorisations

Manage HMRC 64-8 agent authorisation statuses for individual clients. Returns all 11 authorisation types with a user-managed status (Not Requested, Requested, Granted) and a computed IsRequired flag derived from the client's active or proposed services.

OpenAPI Spec

Guides Operations Schemas

GET List Agent Authorisations
Returns all 11 HMRC 64-8 agent authorisation types for the specified client, each with a user-managed status and a computed IsRequired flag derived fr...
/tenants/{tenant}/clients/{client}/agent-authorisations
PUT Update Agent Authorisations
Updates the status of one or more HMRC 64-8 agent authorisation types for the specified client. Only the types included in the request are updated; ot...
/tenants/{tenant}/clients/{client}/agent-authorisations
POST Send HMRC Authorisation Requests
Creates HMRC agent authorisation requests for the specified types. Digital types (MTD-IT, MTD-VAT) create invitations via the REST API and email the c...
/tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-request
POST Submit Letter Auth Code
Submits the authorisation code that HMRC posted to the client (letter-based SA, CT, PAYE/CIS flow). On success the authorisation status is set to Gran...
/tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-submit-code
POST Send Code Entry Link
Emails the client a secure link for entering the authorisation codes HMRC posted to them. One link covers every letter-based request the client is wai...
/tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-send-code-link
POST Reissue Letter Auth Code
Requests HMRC to re-issue an authorisation code for a pending letter-based request. HMRC will post a new code to the client.
/tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-reissue-code/{authorisationType}
POST Confirm HMRC Authorisation Held
Marks a letter-based request as granted when the authorisation is already in place at HMRC without the code having come through SodiumHQ (for example,...
/tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-confirm-held/{authorisationType}
DELETE Cancel HMRC Authorisation Request
Cancels a pending HMRC agent authorisation request and resets the record status to Not Requested. A digital invitation is withdrawn at HMRC; a letter-...
/tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-request/{authorisationType}
DELETE Deauthorise HMRC Authorisation
Removes an existing HMRC agent authorisation and resets the record status.
/tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-deauthorise/{authorisationType}
POST Verify Authorisation With HMRC
Asks HMRC whether the practice currently holds a Making Tax Digital authorisation for this client, and in what capacity. A confirmation sets the statu...
/tenants/{tenant}/clients/{client}/agent-authorisations/verify