Create a registered email address filing resource.

Request

POST https://api.company-information.service.gov.uk/transactions/{transaction_id}/registered-email-address

Path parameters

Parameter name Value Description Additional
transaction_id string

transaction id

Required

Request body

The request body takes a complete registeredEmailAddress resource, containing the following writable properties:

{
    "accept_appropriate_email_address_statement": "boolean",
    "registered_email_address": "string"
}

Properties

Name Type Description Additional
accept_appropriate_email_address_statement boolean

Setting this to true confirms the new email address is an appropriate email address as outlined in section 88A(2) of the Companies Act 2006

registered_email_address string

Official registered email address for a company

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-email-address.update Company REA 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
201 Created

Registered email address filing resource created within transaction envelope

registeredEmailAddressFiling
400 Bad Request

Bad request

401 Unauthorized

Not authorised to create a registered email address filing resource within this transaction

403 Forbidden

Registered email address filing resource cannot be created as it's containing transaction has been closed, or the company does not already have a registered email address

404 Not Found

Transaction not found

409 Conflict

Conflict. Occurs when a registered email address filing resource already exists for the given transaction