Policy Holds API

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

Endpoint Index

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

fetchEntityHold

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EntityHold
Security Group:holds   Permission:read

EntityHold

required
locator string
referenceLocator string
state Enum draft | validated | active | discarded | released
description string
holdStaticData boolean
policyHoldScope PolicyHoldScope
quoteHoldScope QuoteHoldScope
referenceType Enum policy | quote
createdAt datetime
createdBy uuid

optional
validationResult ValidationResult?

Creation and Update

Create Entity Hold

createEntityHold

PUT /policy/{tenantLocator}/holds

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required

Request:CreateEntityHoldRequest
Response:EntityHold
Security Group:holds   Permission:read

Update Entity Hold

updateEntityHold

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Request:UpdateEntityHoldRequest
Response:EntityHold
Security Group:holds   Permission:write

Execution

Validate Entity Hold

validateEntityHold

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EntityHold
Security Group:holds   Permission:write

Activate Entity Hold

activateEntityHold

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EntityHold
Security Group:holds   Permission:write

Release and Discard

Release Entity Hold

releaseEntityHold

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EntityHold
Security Group:holds   Permission:write

Discard Entity Hold

discardEntityHold

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EntityHold
Security Group:holds   Permission:write

Entities

CreateEntityHoldRequest

required
referenceLocator string
referenceType Enum policy | quote

optional
description string?
holdStaticData boolean?
policyHoldScope PolicyHoldScope?
quoteHoldScope QuoteHoldScope?

PolicyHoldScope

required
allowStaticData boolean
transactionCategory Enum[] issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
transactionType string[]

QuoteHoldScope

required
quoteState Enum validated | underwritten | accepted | priced

EntityHold

required
locator string
referenceLocator string
state Enum draft | validated | active | discarded | released
description string
holdStaticData boolean
policyHoldScope PolicyHoldScope
quoteHoldScope QuoteHoldScope
referenceType Enum policy | quote
createdAt datetime
createdBy uuid

optional
validationResult ValidationResult?

UpdateEntityHoldRequest

required
referenceLocator string
description string
holdStaticData boolean
policyHoldScope PolicyHoldScope
quoteHoldScope QuoteHoldScope
referenceType Enum policy | quote
referenceUpdate boolean

Fetch Holds for a Policy or Quote

Fetch Policy Holds

fetchPolicyHolds

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EntityHold[]
Security Group:policies   Permission:read

Fetch Quote Holds

fetchQuoteHolds

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

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	string	required

Response:EntityHold[]
Security Group:quotes   Permission:read

See Also

• Policy Holds Feature Guide