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¶
optionalcompleted booleansubEntities [SubEntityCreateRequest]values map<string,[string]>
SubEntityCreateRequest¶
requiredcompleted booleanontologyUri stringvalues map<string,[string]>optionallocalId string
Update a policyholder¶
POST /policyholder/update
Request:
Name | Position | Type | Required |
---|---|---|---|
updateRequest | body | PolicyholderUpdateRequest | required |
Response:
PolicyholderResponse
PolicyholderUpdateRequest¶
requiredlocator stringcompleted booleanversion integeroptionaladdSubEntities [SubEntityCreateRequest]deleteSubEntities [string]updateSubEntities [SubEntityUpdateRequest]values map<string,[string]>
SubEntityUpdateRequest¶
requiredlocator stringcompleted booleanontologyUri stringvalues 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¶
requiredpolicyholders [PolicyholderResponse]optionalpagingToken string
PolicyholderResponse¶
requiredlocator stringcreatedTimestamp timestampupdatedTimestamp timestampentity EntityResponseversion integer
EntityResponse¶
requiredlocator stringcreatedTimestamp timestampupdatedTimestamp timestampaccountLocator stringcompleted booleanvalues map<string,[string]>flags [string flag.entity.workflow.complete | flag.entity.workflow.started | flag.entity.canceled | flag.entity.test] (deprecated)revision string (deprecated)optionalsubEntitiesByLocator 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. This operation cannot be undone.
Overwrite policyholder data¶
PATCH /policyholder/{policyholderLocator}/overwriteData
Request:
Name | Position | Type | Required |
---|---|---|---|
overwriteDataRequest | body | PolicyholderOverwriteDataRequest | required |
policyholderLocator | path | string | required |
Response:
PolicyholderOverwriteDataResponse
PolicyholderOverwriteDataRequest¶
requiredoverwrites 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¶
requiredpolicyholderLocator string