# Policy Holds API



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

<EndpointIndex
  names={[
  	'fetchEntityHold',
  	'createEntityHold',
  	'updateEntityHold',
  	'validateEntityHold',
  	'activateEntityHold',
  	'releaseEntityHold',
  	'discardEntityHold',
  	'fetchPolicyHolds',
  	'fetchQuoteHolds',
  ]}
/>

Fetch [#fetch]

Fetch Entity Hold [#fetch-entity-hold]

<ApiEndpoint name="fetchEntityHold" />

<ApiSchema name="EntityHold" />

Creation and Update [#creation-and-update]

Create Entity Hold [#create-entity-hold]

<ApiEndpoint name="createEntityHold" />

Update Entity Hold [#update-entity-hold]

<ApiEndpoint name="updateEntityHold" />

Execution [#execution]

Validate Entity Hold [#validate-entity-hold]

<ApiEndpoint name="validateEntityHold" />

Activate Entity Hold [#activate-entity-hold]

<ApiEndpoint name="activateEntityHold" />

Release and Discard [#release-and-discard]

Release Entity Hold [#release-entity-hold]

<ApiEndpoint name="releaseEntityHold" />

Discard Entity Hold [#discard-entity-hold]

<ApiEndpoint name="discardEntityHold" />

Entities [#entities]

<ApiSchema name="CreateEntityHoldRequest" />

<ApiSchema name="PolicyHoldScope" />

<ApiSchema name="QuoteHoldScope" />

<ApiSchema name="EntityHold" />

<ApiSchema name="UpdateEntityHoldRequest" />

Fetch Holds for a Policy or Quote [#fetch-holds-for-a-policy-or-quote]

Fetch Policy Holds [#fetch-policy-holds]

<ApiEndpoint name="fetchPolicyHolds" />

Fetch Quote Holds [#fetch-quote-holds]

<ApiEndpoint name="fetchQuoteHolds" />

See Also [#see-also]

* [Policy Holds Feature Guide](/features/policy-management/policy-holds)


## API Reference

GET /policy/{tenantLocator}/holds/{locator} — fetchEntityHold
Fetches an entity hold by its locator
Tags: entity-hold-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 EntityHold — OK

PUT /policy/{tenantLocator}/holds — createEntityHold
Fetches all entity holds for the current user
Tags: entity-hold-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
Request body (CreateEntityHoldRequest):
Responses:
  200 EntityHold — OK

PATCH /policy/{tenantLocator}/holds/{locator} — updateEntityHold
Updates an entity hold by its locator
Tags: entity-hold-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Request body (UpdateEntityHoldRequest):
Responses:
  200 EntityHold — OK

PATCH /policy/{tenantLocator}/holds/{locator}/validate — validateEntityHold
Validates an entity hold by its locator
Tags: entity-hold-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 EntityHold — OK

PATCH /policy/{tenantLocator}/holds/{locator}/activate — activateEntityHold
Activates an entity hold by its locator
Tags: entity-hold-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 EntityHold — OK

PATCH /policy/{tenantLocator}/holds/{locator}/release — releaseEntityHold
Releases an entity hold by its locator
Tags: entity-hold-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 EntityHold — OK

PATCH /policy/{tenantLocator}/holds/{locator}/discard — discardEntityHold
Discards an entity hold by its locator
Tags: entity-hold-controller
Permissions: write
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 EntityHold — OK

GET /policy/{tenantLocator}/policies/{locator}/holds — fetchPolicyHolds
Tags: policies-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 EntityHold[] — OK

GET /policy/{tenantLocator}/quotes/{locator}/holds — fetchQuoteHolds
Tags: quotes-controller
Permissions: read
Parameters:
  tenantLocator (uuid, path, required)
  locator (ulid, path, required)
Responses:
  200 EntityHold[] — OK

EntityHold
Properties:
  locator (ulid, required)
  referenceLocator (ulid, required)
  referenceType (Enum quote | policy, required)
  state (Enum draft | validated | active | discarded | released, required)
  holdStaticData (boolean, required)
  description (string, required)
  quoteHoldScope (QuoteHoldScope, required)
  policyHoldScope (PolicyHoldScope, required)
  validationResult (ValidationResult)
  createdAt (datetime, required)
  createdBy (uuid, required)

CreateEntityHoldRequest
Properties:
  referenceType (Enum quote | policy, required)
  referenceLocator (ulid, required)
  description (string)
  quoteHoldScope (QuoteHoldScope)
  policyHoldScope (PolicyHoldScope)
  holdStaticData (boolean)

PolicyHoldScope
Properties:
  transactionCategory (Enum[], required)
  transactionType (string[], required)
  allowStaticData (boolean, required)

QuoteHoldScope
Properties:
  quoteState (Enum validated | underwritten | accepted | priced, required)

UpdateEntityHoldRequest
Properties:
  referenceType (Enum quote | policy, required)
  referenceLocator (ulid, required)
  description (string, required)
  holdStaticData (boolean, required)
  quoteHoldScope (QuoteHoldScope, required)
  policyHoldScope (PolicyHoldScope, required)
  referenceUpdate (boolean, required)