Get eligibilty of a company for registered email address data change functionality.
GET https://api.company-information.service.gov.uk/registered-email-address/company/{company_number}/eligibility
| Parameter name |
Value |
Description |
Additional |
| company_number |
string |
The company number for which eligibility is required
|
Required |
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-email-address.update |
Company REA filing permission |
| https://identity.company-information.service.gov.uk/user/profile.read |
User profile read permission |
The following HTTP status codes may be returned, optionally with a response resource.
| Status code |
Description |
Resource |
| 200 |
OK Eligibity of the company for registered email address
|
companyValidation |
| 400 |
Bad Request Bad request
|
|
| 401 |
Unauthorized Not authorised to get the registered email address eligibility
|
|
| 404 |
Not Found Company not found
|
|