This version is in beta - expect some breaking changes.

Agent Authorisation Test Support API

Dates and amounts
Date Amount
Version and status
Available in Sandbox Yes
Sandbox base URL https://test-api.service.hmrc.gov.uk
Available in Production No

Overview

The Agent Authorisation Test Support API provides test-only ability to accept or reject an authorisation request created with Agent Authorisation API. In normal circumstances, this had to be done by the individual or organisation going through dedicated acceptance UI. For an external test environment, we provide two open test endpoints which conclude the authorisation request with the same effects as UI journey.

Skip to main content

Endpoints

/agent-authorisation-test-support/invitations/{id}

Accept an invitation created with POST /agents/{arn}/invitations.
PUT

Authorisation

This endpoint is open access and requires no Authorization header.

Request headers

Request headers Table
Name Description
Content-Length
required

An empty PUT body must have this header value set to 0.

For example:
Accept
required

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

For example: application/vnd.hmrc.1.0+json

See also fraud prevention.

Response

HTTP status: 204 (No Content)

Error scenarios

Error scenarios table
Scenario HTTP status Code

Missing or unsupported version found in 'Accept' header.

400 (Bad Request)

BAD_REQUEST

Missing or unsupported found in 'Accept' header.

400 (Bad Request)

BAD_REQUEST

Missing 'Accept' header.

406 (Not Acceptable)

ACCEPT_HEADER_INVALID

Invalid 'Accept' header.

406 (Not Acceptable)

ACCEPT_HEADER_INVALID

For error scenarios that are common across all APIs, and for error formats, see our reference guide.


Close Section
/agent-authorisation-test-support/invitations/{id}

Reject an invitation created with POST /agents/{arn}/invitations
DELETE

Authorisation

This endpoint is open access and requires no Authorization header.

Request headers

Request headers Table
Name Description
Accept
required

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

For example: application/vnd.hmrc.1.0+json

See also fraud prevention.

Response

HTTP status: 204 (No Content)

Error scenarios

Error scenarios table
Scenario HTTP status Code

Missing or unsupported version found in 'Accept' header.

400 (Bad Request)

BAD_REQUEST

Missing or unsupported found in 'Accept' header.

400 (Bad Request)

BAD_REQUEST

Missing 'Accept' header.

406 (Not Acceptable)

ACCEPT_HEADER_INVALID

Invalid 'Accept' header.

406 (Not Acceptable)

ACCEPT_HEADER_INVALID

For error scenarios that are common across all APIs, and for error formats, see our reference guide.


Close Section

Skip to main content