WebsiteWe're hiringCourses & Certifications→ Get started for free
API Reference

Upsert a policyholder

put
https://sandbox.uk.rootplatform.com/v1/insurance/policyholders
Body Params
string
enum

The policyholder type.

Allowed:
id
object
required

(Individual policyholders only) Object containing policyholder's identification information.

string

(Individual policyholders only) The policyholder's date of birth in the format YYYYMMDD. Forbidden if id.type is "id" and id.country is "ZA".

string | null
enum

(Individual policyholders only) The gender of the policyholder.

Allowed:
string

Policyholder or primary contact's initials.

string
enum

The policyholders's title.

string
required

Policyholder or primary contact's legal first name.

string

The policyholder or primary contact's legal middle name.

string
required

Policyholder or primary contact's legal last name.

string | null

null is allowed. Policyholder or primary contact's contact email address.

cellphone
phone_other
app_data
object | null

null is allowed. An object containing additional custom data for the policyholder.

string
required

The name of the company that the policyholder represents. Only required when type = company.

string
required

The company's registration number. Only required when type = company.

string

(Company policyholders only) The company's date of establishment in the format YYYYMMDD. Required when type = company.

string

(Company policyholders only) The company's website URL. Required when type = company.

subsidiary_companies
array of strings

(Company policyholders only) An array of subsidiary company names. Required when type = company.

subsidiary_companies
string

(Company policyholders only) The position or role of the primary contact at the company. Required when type = company.

address
object | null

null is allowed. The policyholder's physical address. See below for more details.

Response

Updated 5 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago