HmrcInvitationDetailsDto - SodiumHQ API Schema

Properties

Name	Type	Description
status	enum	Pending Accepted Rejected Expired Cancelled Deauthorised PartialAuth LetterRequested
Pending Accepted Rejected Expired Cancelled Deauthorised PartialAuth LetterRequested
clientActionUrl	string	The URL the client clicks to approve the authorisation on Government Gateway.
The URL the client clicks to approve the authorisation on Government Gateway.
dateRequested	string	When the HMRC invitation was created.
When the HMRC invitation was created.
expiresOn	string	When the HMRC invitation expires.
When the HMRC invitation expires.
codeEntryEmailSentDate	string	When the client was emailed the link for entering the code HMRC posted to them (letter-based requests only). Null when they have not been invited to enter it themselves.
When the client was emailed the link for entering the code HMRC posted to them (letter-based requests only). Null when they have not been invited to enter it themselves.
hmrcCredentialName	string	The name of the HMRC credential set whose Government Gateway login made this letter-based request. Null for digital requests, and for letter requests made before credential sets existed (they use the default set).
The name of the HMRC credential set whose Government Gateway login made this letter-based request. Null for digital requests, and for letter requests made before credential sets existed (they use the default set).

JSON Example

{
  "status": "Pending",
  "clientActionUrl": "string",
  "dateRequested": "2024-01-01T00:00:00Z",
  "expiresOn": "2024-01-01T00:00:00Z",
  "codeEntryEmailSentDate": "2024-01-01T00:00:00Z"
}

Contained in Schemas

ClientAgentAuthorisationDto Represents one of the 11 HMRC agent authorisation types for a client