Skip to main content
POST
/
api
/
v2
/
org
Create organisation with initial user
curl --request POST \
  --url https://api.example.com/api/v2/org \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "conveyancer",
  "registeredName": "<string>",
  "registrationNumber": "<string>",
  "sraIDNumber": "<string>",
  "tradingName": "<string>",
  "vatNumber": "<string>",
  "websiteAddress": "<string>",
  "telephoneNumber": "<string>",
  "emailAddress": "[email protected]",
  "companyLogoUrl": "<string>",
  "subDomain": "<string>",
  "address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "line_3": "<string>",
    "post_town": "<string>",
    "county": "<string>",
    "postcode": "<string>",
    "uprn": "<string>"
  },
  "user": {
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "role": "EstateAgent",
    "suffix": "<string>",
    "sraIDNumber": "<string>",
    "telephoneNumber": "<string>",
    "bio": "<string>",
    "avatarUrl": "<string>",
    "email": "[email protected]"
  }
}
'
{
  "id": "<string>",
  "subDomain": "<string>",
  "userId": "<string>",
  "memberId": "<string>"
}

Body

application/json
type
enum<string>
required
Available options:
conveyancer,
estateAgent,
remortgager
registeredName
string
required
registrationNumber
string
required
sraIDNumber
string
required

Required when type is conveyancer

tradingName
string
required
vatNumber
string
required
websiteAddress
string
required
telephoneNumber
string
required

Phone number in E.164 format (e.g. +447911123456)

emailAddress
string<email>
required
companyLogoUrl
string
required
subDomain
string
required

Subdomain for the organisation (validated and must be unique)

address
object
required

Postal address

user
object
required

Initial user account to create

Response

Organisation and user created

id
string

Organisation ID

subDomain
string
userId
string

Generated user ID

memberId
string

Team member ID