Send HMRC Authorisation Requests

POST /tenants/{tenant}/clients/{client}/agent-authorisations/hmrc-request

Creates HMRC agent authorisation requests for the specified types. Digital types (MTD-IT, MTD-VAT) create invitations via the REST API and email the client. Letter-based types (SA, CT, PAYE/CIS) submit via the GovTalk XML API and HMRC posts a code to the client.

Parameters

Name	Type	Description
tenant*	path string	The Tenant.Code
The Tenant.Code
client*	path string

Request Body*

SendHmrcAuthorisationRequestDto

{
  "authorisationTypes": [
    "SelfAssessment"
  ],
  "clientId": "string",
  "knownFact": "string",
  "recipientEmails": [
    "string"
  ],
  "postcode": "string"
}

Responses

200 OK

HmrcBatchRequestResult

400 Bad Request

401 Unauthorized – Invalid or missing API key

404 Not Found