Search
K
uk-property-lodging-party v1

Fetch all external authority identifiers for a lodging party

Fetch all external authority identifiers from different authorities for the specified lodging party.

Required Permission: view:lodgement_identifiers AND view:revenue_identifiers

This endpoint returns identifiers for both revenue authorities (like HMRC) and lodgement authorities (like HMLR).
The storn field is conditionally included only for HMRC revenue authorities.

get
https://api.pexa.co.uk/pexago/api/lodgement/v1/lodging-party/{subscriberId}/ext-authority-identifiers

Path Parameters

subscriberIdstring(uuid)required

Lodging Party Subscriber Id

Response

application/json

OK

Response containing a list of external authority identifiers.

Response Structure:

  • HMRC authorities (authorityAlias: "hmrc") include the storn field
  • Non-HMRC authorities (like HMLR) do not include the storn field
recordsarray[object]

Represents an external authority identifier with conditional field inclusion based on authority type.

Field Inclusion Rules:

  • id, authorityType, authorityAlias: Always present
  • storn: Only present for HMRC revenue authorities
Show Child Parameters
get/pexago/api/lodgement/v1/lodging-party/{subscriberId}/ext-authority-identifiers
 
application/json

ExternalAuthorityIdentifiersResponse

object

Response containing a list of external authority identifiers.

Response Structure:

  • HMRC authorities (authorityAlias: "hmrc") include the storn field
  • Non-HMRC authorities (like HMLR) do not include the storn field
recordsarray[object]

Represents an external authority identifier with conditional field inclusion based on authority type.

Field Inclusion Rules:

  • id, authorityType, authorityAlias: Always present
  • storn: Only present for HMRC revenue authorities
Show Child Parameters
Example

AuthorityType

string

Type of authority:

  • revenue: Revenue authorities like HMRC
  • lodgement: Lodgement authorities like HMLR

Allowed values:REVENUELODGEMENT

ExternalAuthorityIdentifier

object

Represents an external authority identifier with conditional field inclusion based on authority type.

Field Inclusion Rules:

  • id, authorityType, authorityAlias: Always present
  • storn: Only present for HMRC revenue authorities
idstring(uuid)

Unique identifier for the authority record

Example:123e4567-e89b-12d3-a456-426614174000

authorityTypestring

Type of authority:

  • revenue: Revenue authorities like HMRC
  • lodgement: Lodgement authorities like HMLR

Allowed values:REVENUELODGEMENT

authorityAliasstring

Alias name for the authority. Common values:

  • hmrc: Her Majesty’s Revenue and Customs (revenue authority)
  • hmlr: HM Land Registry (lodgement authority)

Example:hmrc

Example

BaseAuthorityIdentifier

Base schema for external authority identifiers.

idstring(uuid)

Unique identifier for the authority record

Example:123e4567-e89b-12d3-a456-426614174000

authorityTypestring

Type of authority:

  • revenue: Revenue authorities like HMRC
  • lodgement: Lodgement authorities like HMLR

Allowed values:REVENUELODGEMENT

authorityAliasstring

Alias name for the authority. Common values:

  • hmrc: Her Majesty’s Revenue and Customs (revenue authority)
  • hmlr: HM Land Registry (lodgement authority)

Example:hmrc

Example