Search
K
uk-property-lodging-party v1

Lodgement Service Lodging Party

v1OAS 3.0

This is the lodgement service api for lodging party operations including external authority identifiers.

API Base URL
  • Server 1:https://api.pexa.co.uk

    API Gateway URL

Security
oauth2 (oauth2)

Authorization Code OAuth Flow

Authorize URL: https://login.pexauk.co.uk/authorize

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • view:health_status - Permission to view lodgement health
  • view:lodgement_identifiers - Permission to view external authority identifiers
  • view:revenue_identifiers - Permission to view revenue authority identifiers

Client Credentials OAuth Flow

Token URL: https://login.pexauk.co.uk/oauth/token

Scopes:

  • view:lodgement_identifiers - Permission to view external authority identifiers
  • view:revenue_identifiers - Permission to view revenue authority identifiers
Additional Information
Contact (benjamin.martinhirsch@pexa.com.au)

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