Skip to main content
GOV.UK
Menu
HMRC Developer Hub
  • Documentation
  • Applications
  • Support
  • Service availability

GOV.UK uses cookies to make the site simpler. Find out more about cookies

  1. Home
  2. API Documentation
  3. Agent Authorisation Test Support API v1.0 (Beta)
  • Register
  • Sign in
  • Overview
  • Endpoints
 

This version is in beta - expect some breaking changes.

Agent Authorisation Test Support API

Available in SandboxYes
Sandbox base URLhttps://test-api.service.hmrc.gov.uk
Available in ProductionNo

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 for other request headers which will become mandatory.

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
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 for other request headers which will become mandatory.

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
Is this page not working properly? Is this page not working properly?
  • Cookies
  • Privacy policy
  • Terms and conditions
  • Help using GOV.UK
  • Accessibility statement

Open Government Licence

All content is available under the Open Government Licence v3.0, except where otherwise stated

© Crown Copyright