Get validation status for registered office address resource

Request

GET https://api.company-information.service.gov.uk/transactions/{transaction_id}/registered-office-address/validation-status

Path parameters

Parameter name Value Description Additional
transaction_id string

transaction id

Required

Authorisation

This request requires the use of one of following authorisation methods: OAuth2.

For OAuth 2 authorisation, the following scopes are required:

Scope Description
https://api.company-information.service.gov.uk/company/{company_number}/registered-office-address.update Company ROA filing permission
https://identity.company-information.service.gov.uk/user/profile.read User profile read permission

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Validation status for a registered office address resource.

validationStatus
401 Unauthorized

Not authorised to get the registered office address resource

404 Not Found

Resource not found