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
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
¶requiredlocator stringreferenceLocator stringstate Enum draft | validated | active | discarded | releaseddescription stringholdStaticData booleanpolicyHoldScope PolicyHoldScopequoteHoldScope QuoteHoldScopereferenceType Enum policy | quotecreatedAt datetimecreatedBy uuidoptionalvalidationResult ValidationResult?
Creation and Update
PUT /policy/{tenantLocator}/holds
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:CreateEntityHoldRequest
Response:EntityHold
Security Group:holds  Permission:read
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
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
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
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
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
¶requiredreferenceLocator stringreferenceType Enum policy | quoteoptionaldescription string?holdStaticData boolean?policyHoldScope PolicyHoldScope?quoteHoldScope QuoteHoldScope?
PolicyHoldScope
¶requiredautoRenewalHold booleantransactionCategory Enum[] issuance | change | renewal | cancellation | reinstatement | reversal | aggregatetransactionType string[]
QuoteHoldScope
¶requiredquoteState Enum draft | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded
EntityHold
¶requiredlocator stringreferenceLocator stringstate Enum draft | validated | active | discarded | releaseddescription stringholdStaticData booleanpolicyHoldScope PolicyHoldScopequoteHoldScope QuoteHoldScopereferenceType Enum policy | quotecreatedAt datetimecreatedBy uuidoptionalvalidationResult ValidationResult?
UpdateEntityHoldRequest
¶requiredreferenceLocator stringdescription stringholdStaticData booleanpolicyHoldScope PolicyHoldScopequoteHoldScope QuoteHoldScopereferenceType Enum policy | quotereferenceUpdate boolean
Fetch Holds for a Policy or Quote
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
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