Skip to main content

Input fields

companyNumber : String

Either an Agency specific id, or an id listed on a public register (e.g. UK Companies House).

name : String! required

Name of the business.

phoneNumber : String

Phone number that's registered with the business.

postcode : String! required

Postcode of the business's primary address.

proprietorInput : ProprietorInput! required

Details about one of the business owners.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "companyNumber": "you-news-green-science-hotel", "name": "hundred-low-else-particular-respond", "phoneNumber": "else-particular-each-produce-system", "postcode": "than-I-up-value-eat", "proprietorInput": ProprietorInput }