Methods

  • post - Create a registered office address resource
  • get - Get a registered office address resource
  • put - Replace a registered office address resource

Resource

{
    "address_line_1": "string",
    "address_line_2": "string",
    "country": "string",
    "etag": "string",
    "kind": "string",
    "links": {
        "self": "string",
        "validation_status": "string"
    },
    "locality": "string",
    "po_box": "string",
    "postal_code": "string",
    "premises": "string",
    "reference_etag": "string",
    "region": "string"
}

Properties

Name Type Description Additional
address_line_1 string

The first line of the address.

address_line_2 string

The second line of the address.

Optional
country string

The country.

Possible values are:

  • England
  • Wales
  • Scotland
  • Northern Ireland
  • Great Britain
  • United Kingdom
  • Not specified
etag string

The ETag of the resource.

Optional, read only.
kind string

The type of resource.

Possible values are:

  • registered-office-address
Optional, read only.
links object

Links to the related resources

Optional, read only.
links.self string

URL to this resource.

Read only.
links.validation_status string

The URL of the validation status resource for the resource.

Optional, read only.
locality string

The locality e.g London.

po_box string

The post-office box number.

Optional
postal_code string

The postal code e.g CF14 3UZ.

Optional
premises string

The property name or number.

reference_etag string

The latest etag read from the current ROA API resource (/company/{company_number}/registered-office-address) on the public register. If this reference etag does not match the current register the request will be rejected.

region string

The region e.g Surrey.

Optional