Properties
| Name | Type | Description |
|---|---|---|
| businessName* | string | The registered business name |
The registered business name | ||
| registrationAuthority* | enum | CompaniesHouse Other |
CompaniesHouse Other | ||
| registrationNumber* | string | The registration number: a company number for Companies House, else a UTR or VAT number |
The registration number: a company number for Companies House, else a UTR or VAT number | ||
| website* | string | The public website, or a verified social media page |
The public website, or a verified social media page | ||
| address* | MessagingNumberApplicationAddressDto | |
| representative* | MessagingNumberApplicationRepresentativeDto | |
| requestedPhoneNumber | string | The number chosen from the available numbers, E.164; null for the first available. A chosen number taken |
The number chosen from the available numbers, E.164; null for the first available. A chosen number taken | ||
| agreedToCosts | boolean | The applicant agrees to the number's monthly price and to paying for the credits the practice buys, as the page |
The applicant agrees to the number's monthly price and to paying for the credits the practice buys, as the page | ||
JSON Example
{
"businessName": "string",
"registrationAuthority": "CompaniesHouse",
"registrationNumber": "string",
"website": "https://example.com",
"address": {
"street": "string",
"streetSecondary": "string",
"city": "string",
"region": "string",
"postalCode": "string",
"isoCountry": "string"
},
"representative": {
"firstName": "string",
"lastName": "string",
"email": "user@example.com",
"phoneNumber": "string"
}
}