Policy Holds API

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

Endpoint Index

ActionEndpoint
Fetch Entity HoldGET /policy/{tenantLocator}/holds/{locator}
Create Entity HoldPUT /policy/{tenantLocator}/holds
Update Entity HoldPATCH /policy/{tenantLocator}/holds/{locator}
Validate Entity HoldPATCH /policy/{tenantLocator}/holds/{locator}/validate
Activate Entity HoldPATCH /policy/{tenantLocator}/holds/{locator}/activate
Release Entity HoldPATCH /policy/{tenantLocator}/holds/{locator}/release
Discard Entity HoldPATCH /policy/{tenantLocator}/holds/{locator}/discard
Fetch Policy HoldsGET /policy/{tenantLocator}/policies/{locator}/holds
Fetch Quote HoldsGET /policy/{tenantLocator}/quotes/{locator}/holds

Fetch

Fetch Entity Hold
fetchEntityHold
GET /policy/{tenantLocator}/holds/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    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
Update Entity Hold
updateEntityHold
PATCH /policy/{tenantLocator}/holds/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:EntityHold
    Security Group:holds   Permission:write

Execution

Validate Entity Hold
validateEntityHold
PATCH /policy/{tenantLocator}/holds/{locator}/validate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:EntityHold
    Security Group:holds   Permission:write
Activate Entity Hold
activateEntityHold
PATCH /policy/{tenantLocator}/holds/{locator}/activate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:EntityHold
    Security Group:holds   Permission:write

Release and Discard

Release Entity Hold
releaseEntityHold
PATCH /policy/{tenantLocator}/holds/{locator}/release
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:EntityHold
    Security Group:holds   Permission:write
Discard Entity Hold
discardEntityHold
PATCH /policy/{tenantLocator}/holds/{locator}/discard
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    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
autoRenewalHold boolean
transactionCategory Enum[] issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
transactionType string[]
QuoteHoldScope
required
quoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
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:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:EntityHold[]
    Security Group:policies   Permission:read
Fetch Quote Holds
fetchQuoteHolds
GET /policy/{tenantLocator}/quotes/{locator}/holds
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Response:EntityHold[]
    Security Group:quotes   Permission:read

See Also