HTTP header
|
Description
|
Coverage
|
Gov-Client-Public-IP
|
The public
IP address (IPv4 or IPv6) from which the originating device makes the
request.
|
Not in
scope of the current hotfix.
|
Gov-Client-Public-Port
|
The public
TCP port that the originating device uses when initiating the request.
|
Not in
scope of the current hotfix.
|
Gov-Client-Device-ID
|
An
identifier unique to an originating device.
|
Included into
the current hotfix.
|
Gov-Client-User-IDs
|
A key-value
data structure containing the user identifiers.
|
Included into
the current hotfix.
|
Gov-Client-Timezone
|
The local time-zone
of the originating device.
|
Included into
the current hotfix.
|
Gov-Client-Local-IPs
|
A list of
all local IP addresses (IPv4 and IPv6) available to the originating device.
|
Not in
scope of the current hotfix.
|
Gov-Client-Screens
|
Information
related to the originating device’s screens. The fields include:
- width is the reported width of the screen, in pixels
- height is the reported height of the screen, in
pixels
- scaling-factor is the reported scaling factor of the
screen.
- color-depth is the color depth of the screen, in
bits.
|
Included into
the current hotfix.
|
Gov-Client-Window-Size
|
The number
of pixels of the window on the originating device in which the user initiated
(directly or indirectly) the API call to HMRC.
|
Included into
the current hotfix.
|
Gov-Client-User-Agent
|
An attempt
to identify the operating system family, version, device manufacturer and
model of the originating device.
|
Partially included
into the current hotfix. (OS version only)
|
Gov-Client-Multi-Factor
|
A list of
key-value data structures containing details of the multi-factor
authentication (MFA) statuses related to the API call.
|
Not in
scope of the current hotfix.
|
Gov-Vendor-Version
|
A key-value
data structure of software versions involved in handling a request.
|
Included into
the current hotfix.
|
Gov-Vendor-License-IDs
|
A key-value
data structure of hashed license keys relating to the vendor software
initiating the API request on the originating device.
|
Not in
scope of the current hotfix.
|
Gov-Vendor-Public-IP
|
The public
IP address of the servers to which the originating device sent their
requests.
|
Not in
scope of the current hotfix.
|
Gov-Client-MAC-Addresses
|
The list of
MAC addresses available on the originating device.
|
Included into
the current hotfix.
|
Gov-Vendor-Forwarded
|
A list that
details hops over the internet between services that terminate TLS.
|
Not in
scope of the current hotfix.
|