Policyholder API

Endpoint Index

Action	Endpoint
Create a policyholder	POST /policyholder/create
Update a policyholder	POST /policyholder/update
Fetch policyholders	GET /policyholders
Fetch a policyholder	GET /policyholder/{policyholderLocator}
Fetch policies for policyholder	GET /policyholder/{policyholderLocator}/policies
Fetch invoices for policyholder	GET /policyholder/{policyholderLocator}/invoices
Overwrite policyholder data	PATCH /policyholder/{policyholderLocator}/overwriteData

Policyholder Creation and Update

Create a policyholder¶

POST /policyholder/create

Request:

Name	Position	Type	Required
request	body	PolicyholderCreateRequest	required

Response: PolicyholderResponse

PolicyholderCreateRequest¶

optional
completed boolean
subEntities [SubEntityCreateRequest]
values map<string,[string]>

SubEntityCreateRequest¶

required
completed boolean
ontologyUri string
values map<string,[string]>

optional
localId string

Update a policyholder¶

POST /policyholder/update

Request:

Name	Position	Type	Required
updateRequest	body	PolicyholderUpdateRequest	required

Response: PolicyholderResponse

PolicyholderUpdateRequest¶

required
locator string
completed boolean
version integer

optional
addSubEntities [SubEntityCreateRequest]
deleteSubEntities [string]
updateSubEntities [SubEntityUpdateRequest]
values map<string,[string]>

SubEntityUpdateRequest¶

required
locator string
completed boolean
ontologyUri string
values map<string,[string]>

Policyholder Fetch

Fetch policyholders¶

GET /policyholders

Request:

Name	Position	Type	Required
createdAfterTimestamp	query	timestamp	optional
createdBeforeTimestamp	query	timestamp	optional
pageSize	query	integer	optional
pagingToken	query	string	optional

Response: PolicyholderPageResponse

Fetch a policyholder¶

GET /policyholder/{policyholderLocator}

Request:

Name	Position	Type	Required
policyholderLocator	path	string	required

Response: PolicyholderResponse

PolicyholderPageResponse¶

required
policyholders [PolicyholderResponse]

optional
pagingToken string

PolicyholderResponse¶

required
locator string
createdTimestamp timestamp
updatedTimestamp timestamp
entity EntityResponse
version integer

EntityResponse¶

required
locator string
createdTimestamp timestamp
updatedTimestamp timestamp
accountLocator string
completed boolean
values map<string,[string]>
flags [string flag.entity.workflow.complete | flag.entity.workflow.started | flag.entity.canceled | flag.entity.test] (deprecated)
revision string (deprecated)

optional
subEntitiesByLocator map<string,EntityResponse>

Associated Data

Fetch policies for policyholder¶

GET /policyholder/{policyholderLocator}/policies

Request:

Name	Position	Type	Required
policyholderLocator	path	string	required

Response: [PolicyResponse]

Fetch invoices for policyholder¶

GET /policyholder/{policyholderLocator}/invoices

Request:

Name	Position	Type	Required
policyholderLocator	path	string	required

Response: [PolicyInvoiceResponse]

Overwriting Policyholder Data

Warning

The following endpoint is intended to be only used when all indicated data fields are to be permanently expunged from Socotra. We recommend contacting Socotra support for any needs to expunge data from the system.

Overwrite policyholder data¶

PATCH /policyholder/{policyholderLocator}/overwriteData

Request:

Name	Position	Type	Required
overwriteDataRequest	body	PolicyholderOverwriteDataRequest	required
policyholderLocator	path	string	required

Response: PolicyholderOverwriteDataResponse

PolicyholderOverwriteDataRequest¶

required
overwrites map<string,string>

For the overwrites property, provide a map of field names to new values to use in overwriting. For example:

{
    "first_name": "firstnamexxx",
    "last_name": "lastnamexxx",
    "street": "streetnamexxx",
    "email_address": "emailoverwritten@xyz.com"
}

PolicyholderOverwriteDataResponse¶

required
policyholderLocator string