Policy Holds API

Policy Holds are used to temporarily block policy transactions and to suspend the auto-renewal process.

Action	Endpoint
Fetch Entity Hold	GET/policy/{tenantLocator}/holds/{locator}
Create Entity Hold	PUT/policy/{tenantLocator}/holds
Update Entity Hold	PATCH/policy/{tenantLocator}/holds/{locator}
Validate Entity Hold	PATCH/policy/{tenantLocator}/holds/{locator}/validate
Activate Entity Hold	PATCH/policy/{tenantLocator}/holds/{locator}/activate
Release Entity Hold	PATCH/policy/{tenantLocator}/holds/{locator}/release
Discard Entity Hold	PATCH/policy/{tenantLocator}/holds/{locator}/discard
Fetch Policy Holds	GET/policy/{tenantLocator}/policies/{locator}/holds
Fetch Quote Holds	GET/policy/{tenantLocator}/quotes/{locator}/holds

Fetch

Fetch Entity Hold

Fetch Entity HoldfetchEntityHold

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

Parameters

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

Response:EntityHold

Security Group:holds

Permission:

read

EntityHold

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`state`	`Enum draft \| validated \| active \| discarded \| released`
`description`	`string`
`holdStaticData`	`boolean`
`policyHoldScope`	`PolicyHoldScope`
`quoteHoldScope`	`QuoteHoldScope`
`referenceType`	`Enum quote \| policy`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`

Creation and Update

Create Entity Hold

Create Entity HoldcreateEntityHold

PUT/policy/{tenantLocator}/holds

Parameters

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

Request:CreateEntityHoldRequest

Response:EntityHold

Security Group:holds

Permission:

read

Update Entity Hold

Update Entity HoldupdateEntityHold

PATCH/policy/{tenantLocator}/holds/{locator}

Parameters

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

Request:UpdateEntityHoldRequest

Response:EntityHold

Security Group:holds

Permission:

write

Execution

Validate Entity Hold

Validate Entity HoldvalidateEntityHold

PATCH/policy/{tenantLocator}/holds/{locator}/validate

Parameters

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

Response:EntityHold

Security Group:holds

Permission:

write

Activate Entity Hold

Activate Entity HoldactivateEntityHold

PATCH/policy/{tenantLocator}/holds/{locator}/activate

Parameters

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

Response:EntityHold

Security Group:holds

Permission:

write

Release and Discard

Release Entity Hold

Release Entity HoldreleaseEntityHold

PATCH/policy/{tenantLocator}/holds/{locator}/release

Parameters

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

Response:EntityHold

Security Group:holds

Permission:

write

Discard Entity Hold

Discard Entity HolddiscardEntityHold

PATCH/policy/{tenantLocator}/holds/{locator}/discard

Parameters

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

Response:EntityHold

Security Group:holds

Permission:

write

Entities

CreateEntityHoldRequest

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`referenceType`	`Enum quote \| policy`

Optional properties

Property	Type	Description
`description`	`string?`
`holdStaticData`	`boolean?`
`policyHoldScope`	`PolicyHoldScope?`
`quoteHoldScope`	`QuoteHoldScope?`

PolicyHoldScope

Required properties

Property	Type	Description
`allowStaticData`	`boolean`
`transactionCategory`	`Enum[] issuance \| change \| renewal \| cancellation \| reinstatement \| reversal \| aggregate`
`transactionType`	`string[]`

QuoteHoldScope

Required properties

Property	Type	Description
`quoteState`	`Enum validated \| underwritten \| accepted \| priced`

EntityHold

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`state`	`Enum draft \| validated \| active \| discarded \| released`
`description`	`string`
`holdStaticData`	`boolean`
`policyHoldScope`	`PolicyHoldScope`
`quoteHoldScope`	`QuoteHoldScope`
`referenceType`	`Enum quote \| policy`
`createdAt`	`datetime`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`

UpdateEntityHoldRequest

Required properties

Property	Type	Description
`referenceLocator`	`ulid`
`description`	`string`
`holdStaticData`	`boolean`
`policyHoldScope`	`PolicyHoldScope`
`quoteHoldScope`	`QuoteHoldScope`
`referenceType`	`Enum quote \| policy`
`referenceUpdate`	`boolean`

Fetch Holds for a Policy or Quote

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

Fetch Quote Holds

Fetch Quote HoldsfetchQuoteHolds

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

Parameters

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

Response:EntityHold[]

Security Group:quotes

Permission:

read

Policy Holds API

Fetch

Fetch Entity Hold

Creation and Update

Create Entity Hold

Update Entity Hold

Execution

Validate Entity Hold

Activate Entity Hold

Release and Discard

Release Entity Hold

Discard Entity Hold

Entities

Fetch Holds for a Policy or Quote

Fetch Policy Holds

Fetch Quote Holds

See Also

On this page