Search
K
uk-property-lodging-party v1

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

HmrcAuthorityIdentifier

HMRC-specific external authority identifier that includes the STORN field.

Examples:

HMRC Revenue Authority (includes STORN):

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "authorityType": "REVENUE",
  "authorityAlias": "hmrc",
  "storn": "STORN123456789"
}

HMLR Lodgement Authority (no STORN field):

{
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "authorityType": "LODGEMENT",
  "authorityAlias": "hmlr"
}
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

stornstring

STORN (Stamp Taxes Online Reference Number)

This field is required for HMRC revenue authorities.
The STORN is used by HMRC for stamp duty land tax transactions and provides a unique reference for tax-related processes.
example: “STORN123456789”

Example

ErrorResponse

object
errorsarray[object]
Show Child Parameters
Example