Sign in

v1

latestOpenAPI 3.0.32026-07-1362171.8 KB
Agents

Get an invitation by id

get/agents/{arn}/invitations/{invitationId}

Path parameters

arnstring required
Example:AARN9999999

The Making Tax Digital (MTD) platform Agent Reference Number. For format and validation of Agent Reference Number See here

invitationIdstring required
Example:CS5AK7O8FPC43

A unique authorisation request ID

Headers

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Response

The authorisation request

arnstring required

The Agent Registration Number for the calling agency

createdstring date-time required

Creation time of the request (RFC3339 / ISO8601 format)

updatedstring date-time

Update time of the request (RFC3339 / ISO8601 format)

expiresOnstring date

Expiration time of the request (RFC3339 / ISO8601 format)

status'Pending' | 'Accepted' | 'Rejected' | 'Cancelled' | 'Deauthorised' | 'Expired' | 'Partialauth' required

The current status of the invitation

clientActionUrlstring uri

Link for the client to authorise/reject this agent's invitation.

agentType'main' | 'supporting' nullable

Only MTD-IT supports this field. Defaults to "main" if omitted.