Policies API

Action	Endpoint
Fetch a Policy	GET/policy/{tenantLocator}/policies/{locator}
Add Static Data to a Policy	POST/policy/{tenantLocator}/policies/{locator}/static
Update Static Data on a Policy	PATCH/policy/{tenantLocator}/policies/{locator}/static
Replace All Static Data on a Policy	PUT/policy/{tenantLocator}/policies/{locator}/static
Fetch Static Data for a Policy	GET/policy/{tenantLocator}/policies/{locator}/static
List Static Data for a Policy	GET/policy/{tenantLocator}/policies/{locator}/static/history/list
Fetch a Policy Snapshot	GET/policy/{tenantLocator}/policies/{locator}/snapshot
Fetch Multiple Snapshots	GET/policy/{tenantLocator}/policies/snapshot/list
Update Billing Level For APolicy	PATCH/policy/{tenantLocator}/policies/{locator}/billingLevel
Fetch Policies With Number	GET/policy/{tenantLocator}/policies/numbers/{policyNumber}
Set Policy Number	POST/policy/{tenantLocator}/policies/{locator}/number/set
Set Reserved Policy Number	POST/policy/{tenantLocator}/quotes/{locator}/reservedPolicyNumber/set
Generate Policy Number	POST/policy/{tenantLocator}/policies/{locator}/number/generate
Add policy contact	POST/policy/{tenantLocator}/policies/{policyLocator}/contacts
Delete policy contact	DELETE/policy/{tenantLocator}/policies/{policyLocator}/contacts/{contactLocator}
Fetch policy contacts	GET/policy/{tenantLocator}/policies/{policyLocator}/contacts
Update policy contact	PATCH/policy/{tenantLocator}/policies/{policyLocator}/contacts/{contactLocator}
Update Policy Jurisdiction	PATCH/policy/{tenantLocator}/policies/{locator}/jurisdiction
Create Quote From Policy	POST/policy/{tenantLocator}/policies/{locator}/quote

Fetch

Fetch a Policy

Fetch a PolicyfetchPolicy

GET/policy/{tenantLocator}/policies/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyResponse

Security Group:policies

Permission:

read

PolicyResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`issuedTransactionLocator`	`ulid`	The locator of the latest issued transaction for the policy.
`latestSegmentLocator`	`ulid`	The last segment on the policy, based on issued transactions only
`latestTermLocator`	`ulid`
`productName`	`string`
`startTime`	`datetime`	The start time, based on issued transactions only
`endTime`	`datetime`	The end time based on issued transactions only.
`currency`	`string`
`durationBasis`	`Enum years \| months \| weeks \| days \| hours`
`timezone`	`string`
`billingLevel`	`Enum account \| inherit \| policy`
`static`	`map<string, object>`
`createdAt`	`datetime`
`createdBy`	`uuid`
`contacts`	`ContactRoles[]`
`moratoriumElections`	`map<string, string>`
`statuses`	`Enum[] pending \| expired \| cancelled \| cancelPending \| onRisk \| delinquent \| doNotRenew`

Optional properties

Property	Type	Description
`region`	`string?`
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`anonymizedAt`	`datetime?`
`coverageEndTime`	`datetime?`
`invoiceFeeAmount`	`number?`
`jurisdiction`	`string?`
`policyNumber`	`string?`
`producerCode`	`string?`
`producerCodeOfRecord`	`string?`
`validationResult`	`ValidationResult?`
`branchHeadTransactionLocators`	`ulid[]?`	The locators of all the top-level transactions on the policy, one per branch

Fetch all Policies for an Account

Fetch all Policies for an AccountfetchPoliciesForAccount

GET/policy/{tenantLocator}/accounts/{locator}/policies/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`includeStaticData`	query	`boolean?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:PolicyListResponse

Security Group:accounts

Permissions:

read,list

PolicyListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`PolicyResponse[]`

Static Data

Add Static Data to a Policy

Add Static Data to a PolicyaddStaticDataForPolicy

POST/policy/{tenantLocator}/policies/{locator}/static

Set the static extension data on a policy

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:map<string, object>

Response:PolicyResponse

Security Group:policies

Permission:

write

Update Static Data on a Policy

Update Static Data on a PolicyupdateStaticDataForPolicy

PATCH/policy/{tenantLocator}/policies/{locator}/static

Updates some of the static data on a policy

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:StaticDataUpdateRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

StaticDataUpdateRequest

Required properties

Property	Type	Description
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Replace All Static Data on a Policy

Replace All Static Data on a PolicyreplaceAllStaticDataForPolicy

PUT/policy/{tenantLocator}/policies/{locator}/static

Replaces all of the static data on a policy

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:map<string, object>

Response:PolicyResponse

Security Group:policies

Permission:

write

Fetch Static Data for a Policy

Fetch Static Data for a PolicyfetchStaticDataForPolicy

GET/policy/{tenantLocator}/policies/{locator}/static

Gets the static data on a policy

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:map<string, object>

Security Group:policies

Permission:

read

List Static Data for a Policy

List Static Data for a PolicylistStaticDataForPolicy

GET/policy/{tenantLocator}/policies/{locator}/static/history/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:ListPageResponseStaticDataHistoryResponse

Security Group:policies

Permission:

read

ListPageResponseStaticDataHistoryResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`StaticDataHistoryResponse[]`

StaticDataHistoryResponse

Required properties

Property	Type	Description
`historyLocator`	`ulid`
`updatedAt`	`datetime`
`updatedBy`	`uuid`
`staticData`	`map<string, object>`

Snapshots

Fetch a Policy Snapshot

Fetch a Policy SnapshotfetchPolicySnapshot

GET/policy/{tenantLocator}/policies/{locator}/snapshot

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`date`	query	`datetime`	Yes
`byIssuedTime`	query	`boolean?`	No

Response:PolicySnapshotResponse

Security Group:policies

Permission:

read

Fetch Multiple Snapshots

Fetch Multiple SnapshotsfetchMultipleSnapshotsDeprecated

GET/policy/{tenantLocator}/policies/snapshot/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No

Response:PolicySnapshotResponse[]

Security Group:policies

Permissions:

read,list

PolicySnapshotListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`PolicySnapshotResponse[]`

PolicySnapshotResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`region`	`string`
`productName`	`string`
`currency`	`string`
`timezone`	`string`
`transaction`	`TransactionSnapshotResponse`
`static`	`map<string, object>`

Optional properties

Property	Type	Description
`delinquencyPlanName`	`string?`

TransactionSnapshotResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`effectiveTime`	`datetime`
`issuedTime`	`datetime`
`preferences`	`PreferencesResponse`
`segment`	`SegmentResponse`
`transactionCategory`	`Enum issuance \| change \| renewal \| cancellation \| reinstatement \| reversal \| aggregate`
`transactionType`	`string`

Billing

Update Billing Level For APolicy

Update Billing Level For A PolicyupdateBillingLevelForAPolicy

PATCH/policy/{tenantLocator}/policies/{locator}/billingLevel

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UpdateBillingLevelRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

UpdateBillingLevelRequest

Required properties

Property	Type	Description
`billingLevel`	`Enum account \| inherit \| policy`

Update the Delinquency Plan Assigned to a Policy

Update the Delinquency Plan Assigned to a PolicyupdatePolicyDelinquencyPlan

PATCH/policy/{tenantLocator}/policies/{locator}/delinquencyPlan

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:DelinquencyPlanUpdateRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

Numbering

Fetch Policies With Number

Fetch Policies With NumberfetchPoliciesWithNumber

GET/policy/{tenantLocator}/policies/numbers/{policyNumber}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`policyNumber`	path	`string`	Yes

Response:PolicyResponse[]

Security Group:policies

Permissions:

read,list

Set Policy Number

Set Policy NumbersetPolicyNumber

POST/policy/{tenantLocator}/policies/{locator}/number/set

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`policyNumber`	query	`string`	Yes

Response:PolicyResponse

Security Group:policies

Permission:

write

Set Reserved Policy Number

Set Reserved Policy NumbersetReservedPolicyNumber

POST/policy/{tenantLocator}/quotes/{locator}/reservedPolicyNumber/set

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`reservedPolicyNumber`	query	`string`	Yes

Response:QuoteResponse

Security Group:quotes

Permissions:

write,reserve-policy-number-set

Generate Policy Number

Generate Policy NumbergeneratePolicyNumber

POST/policy/{tenantLocator}/policies/{locator}/number/generate

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyResponse

Security Group:policies

Permission:

write

Contacts

Add policy contact

Add policy contactaddPolicyContact

POST/policy/{tenantLocator}/policies/{policyLocator}/contacts

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes

Request:ContactRoles

Response:PolicyResponse

Security Group:policies

Permission:

write

ContactRoles

Required properties

Property	Type	Description
`contactLocator`	`ulid`
`roles`	`string[]`

Delete policy contact

Delete policy contactdeletePolicyContact

DELETE/policy/{tenantLocator}/policies/{policyLocator}/contacts/{contactLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Response:PolicyResponse

Security Group:policies

Permission:

write

Fetch policy contacts

Fetch policy contactsfetchPolicyContacts

GET/policy/{tenantLocator}/policies/{policyLocator}/contacts

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes

Response:ContactRoles[]

Security Group:policies

Permission:

write

Update policy contact

Update policy contactupdatePolicyContact

PATCH/policy/{tenantLocator}/policies/{policyLocator}/contacts/{contactLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`policyLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Request:ContactAssociationUpdateRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

Holds

Fetch Policy Holds

Fetch Policy HoldsfetchPolicyHolds

GET/policy/{tenantLocator}/policies/{locator}/holds

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:EntityHold[]

Security Group:policies

Permission:

read

Jurisdictions

Update Policy Jurisdiction

Update Policy JurisdictionupdatePolicyJurisdiction

PATCH/policy/{tenantLocator}/policies/{locator}/jurisdiction

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UpdateJurisdictionRequest

Response:PolicyResponse

Security Group:policies

Permission:

write

UpdateJurisdictionRequest

Properties

Property	Type	Description
`jurisdiction`	`string?`

Create Quote from Policy

Create Quote From Policy

Create Quote From PolicycreateQuoteFromPolicy

POST/policy/{tenantLocator}/policies/{locator}/quote

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`date`	query	`datetime?`	No
`byIssuedTime`	query	`boolean?`	No
`includeStaticData`	query	`boolean?`	No

Response:QuoteResponse

Security Group:policies

Permissions:

write,create-quote

The date parameter specifies the point in time used to identify which policy segment to copy. If a date is not provided, the generated quote will be based on the segment created by the policy's issuance transaction. The byIssuedTime parameter determines whether the provided date is evaluated against the segment's issued time or effective time, and includeStaticData controls whether policy-level static data is included in the generated quote.

Policies API

On this page