Skip to main content
GET
/
api
/
v2
/
org
Get organisation details
curl --request GET \
  --url https://api.example.com/api/v2/org
{
  "id": "<string>",
  "type": "conveyancer",
  "registeredName": "<string>",
  "registrationNumber": "<string>",
  "sraIDNumber": "<string>",
  "tradingName": "<string>",
  "vatNumber": "<string>",
  "websiteAddress": "<string>",
  "telephoneNumber": "<string>",
  "emailAddress": "[email protected]",
  "logoUrl": "<string>",
  "subDomain": "<string>",
  "address": {
    "line_1": "<string>",
    "line_2": "<string>",
    "line_3": "<string>",
    "post_town": "<string>",
    "county": "<string>",
    "postcode": "<string>",
    "uprn": "<string>"
  }
}

Response

Organisation details

id
string

Organisation ID

type
enum<string>

Organisation type

Available options:
conveyancer,
estateAgent,
remortgager
registeredName
string

Registered company name

registrationNumber
string

Company registration number

sraIDNumber
string

SRA ID number

tradingName
string

Trading name

vatNumber
string

VAT number

websiteAddress
string

Website URL

telephoneNumber
string

Phone number

emailAddress
string<email>

Email address

logoUrl
string

Logo URL

subDomain
string | null

Subdomain

address
object

Organisation address