Onboarding

Please refer to the Authentication document on how to obtain and use an API key.

Available actions & endpoints

Create account and send onboarding email

POST /v1/onboarding (Create account and send onboarding email)

URL Parameters

name	type	data type	description
None	N/A	N/A	N/A

Query Parameters

name	required	data type	description
None	N/A	N/A	N/A

Responses

http code	content-type	response
200	application/json	See example response
401	application/json	{"code":401,"message": "Authentication is required to continue"}

Example cURL

 curl -X GET -H "api-key: [YOUR API KEY]" https://api.monitor.insites.com/v1/onboarding

Example Response

{
  "success": true,
  "message": "success"
}

Example Request Body

{
  "email": "technical@insites.com",
  "first_name": "Mr",
  "last_name": "Technical",
  "language_preference": "nl-BE",
  "business": {
    "business_name": "Insites",
    "hostname": "https://www.insites.com"
    "address_line_1": "17 Brunel Parkway",
    "address_line_2": "",
    "address_line_3": "",
    "city": "Derby",
    "county": "Derbyshire",
    "postcode": "DE24 8HR",
    "phone_number": "+441332460400",
    "country_code": "GB"
  }
}

Example Response

{
  "success": true,
  "message": "success",
  "data": {
    "user": {
      "uuid": "7c9140e9-c002-43b4-9c5c-b37525babe13",
      "email": "mikeglenn@insites.com",
      "first_name": "Mike",
      "last_name": "Glenn",
      "language_preference": "en-GB",
      "created_at": "2024-05-28T15:13:54+00:00",
      "updated_at": null
    }
  }
}