Policyholder API

Endpoint Index

ActionEndpoint
Create a policyholderPOST /policyholder/create
Update a policyholderPOST /policyholder/update
Fetch policyholdersGET /policyholders
Fetch a policyholderGET /policyholder/{policyholderLocator}
Fetch policies for policyholderGET /policyholder/{policyholderLocator}/policies
Fetch invoices for policyholderGET /policyholder/{policyholderLocator}/invoices
Overwrite policyholder dataPATCH /policyholder/{policyholderLocator}/overwriteData

Policyholder Creation and Update

Create a policyholder
POST /policyholder/create
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
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:
    NamePositionTypeRequired
    createdAfterTimestampqueryintegeroptional
    createdBeforeTimestampqueryintegeroptional
    pageSizequeryintegeroptional
    pagingTokenquerystringoptional
Fetch a policyholder
GET /policyholder/{policyholderLocator}
    Request:
    NamePositionTypeRequired
    policyholderLocatorpathstringrequired
PolicyholderPageResponse
required
policyholders [PolicyholderResponse]

optional
pagingToken string
PolicyholderResponse
required
locator string
createdTimestamp timestamp
updatedTimestamp timestamp
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:
    NamePositionTypeRequired
    policyholderLocatorpathstringrequired
    Response: [PolicyResponse]
Fetch invoices for policyholder
GET /policyholder/{policyholderLocator}/invoices

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. This operation cannot be undone.

Overwrite policyholder data
PATCH /policyholder/{policyholderLocator}/overwriteData
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