Policy Transactions API
Endpoint Index
Action | Endpoint |
---|---|
Fetch a Transaction | GET /policy/{tenantLocator}/transactions/{locator} |
Fetch Policy Transaction with Updated Changes | GET /policy/{tenantLocator}/transactions/{locator}/elements/changes |
Fetch Policy Segment for a Transaction | GET /policy/{tenantLocator}/transactions/{locator}/segment |
Fetch a Policy Segment | GET /policy/{tenantLocator}/transactions/segments/{segmentLocator} |
Fetch Issued Transactions | GET /policy/{tenantLocator}/policies/{locator}/issuedTransactions/list |
Create a Transaction | PATCH /policy/{tenantLocator}/policies/{locator}/{transactionType} |
Create a Policy Change Transaction | PATCH /policy/{tenantLocator}/policies/{locator}/change |
Create a Renewal Transaction | PATCH /policy/{tenantLocator}/policies/{locator}/renew |
Create a Cancellation Transaction | PATCH /policy/{tenantLocator}/policies/{locator}/cancel |
Create a Reinstatement Transaction | PATCH /policy/{tenantLocator}/policies/{locator}/reinstate |
Create a Reversal Transaction | PATCH /policy/{tenantLocator}/policies/{locator}/reversal |
Initialize Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/initialize |
Add Elements To Policy with Transaction | PUT /policy/{tenantLocator}/transactions/{locator}/elements |
Update Elements In Policy with Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/elements |
Remove Elements From Policy with Transaction | DELETE /policy/{tenantLocator}/transactions/{locator}/elements |
Add a Change Instruction to a Transaction | PUT /policy/{tenantLocator}/transactions/{locator}/changeInstructions |
Update One of a Transaction's Change Instructions | PATCH /policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator} |
Delete a Change Instruction from a Transaction | DELETE /policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator} |
Validate a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/validate |
Price a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/price |
Fetch Pricing for a Transaction | GET /policy/{tenantLocator}/transactions/{locator}/price |
Underwrite a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/underwrite |
Update a Transaction's Underwriting Flags | PATCH /policy/{tenantLocator}/transactions/{locator}/underwritingFlags |
Fetch Underwriting Flags | GET /policy/{tenantLocator}/transactions/{locator}/underwritingFlags |
Accept a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/accept |
Issue a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/issue |
Fetch Preferences for a Transaction | GET /policy/{tenantLocator}/transactions/{locator}/preferences |
Fetch Affected Transactions | GET /policy/{tenantLocator}/transactions/{locator}/affectedTransactions |
Reset a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/reset |
Refuse a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/refuse |
Discard a Transaction | PATCH /policy/{tenantLocator}/transactions/{locator}/discard |
Fetch Transaction Segments | GET /policy/{tenantLocator}/transactions/{locator}/segments/list |
Fetch Policy Segment Ex | GET /policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator} |
Main Flow
Note
For unissued transactions that are elible for issuance, you can attempt to advance to any subsequent state. If the transaction fails to validate, the response will be HTTP 200
, but the transaction itself will not be in the requested new state. The actual state of the transaction will be included in the payload.
Fetch
GET /policy/{tenantLocator}/transactions/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:read
PolicyTransactionResponse
¶requiredlocator locatorpolicyLocator locatortermLocator locatoreffectiveTime datetimetransactionState Enum draft | initialized | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded | invalidated | reversedtransactionCategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregatetransactionType stringcreatedAt datetimecreatedBy uuidoptionalaggregateTransactionLocator locator?baseTransactionLocator locator?issuedTime datetime?acceptedTime datetime?preferences PreferencesResponse?underwritingStatus string?validationResult ValidationResult?aggregatedTransactions PolicyTransactionResponse[]?changeInstructions oneOf<AddChangeInstructionResponse, ModifyChangeInstructionResponse, ParamsChangeInstructionResponse, DeleteChangeInstructionResponse>[]?billingTrigger Enum? accept | issue (deprecated)
PreferencesResponse
¶optionalbillingPreferences BillingPreferences?installmentPreferences InstallmentPreferences?
BillingPreferences
¶optionalbillingPlanName string?billingLevel Enum? account | inherit | policy
InstallmentPreferences
¶requiredinstallmentWeights number[]optionalinstallmentPlanName string?anchorMode Enum? generateDay | termStartDay | dueDayanchorTime datetime?anchorType Enum? none | dayOfMonth | anchorTime | dayOfWeek | weekOfMonthcadence Enum? none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDaysdayOfMonth int?dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sundaydueLeadDays int?generateLeadDays int?maxInstallmentsPerTerm int?weekOfMonth Enum? none | first | second | third | fourth | fifth
GET /policy/{tenantLocator}/transactions/{locator}/elements/changes
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:read
GET /policy/{tenantLocator}/transactions/{locator}/segment
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:SegmentResponse
Security Group:transactions  Permission:read
GET /policy/{tenantLocator}/transactions/segments/{segmentLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
segmentLocator | path | locator | required |
Response:SegmentResponse
Security Group:transactions  Permission:read
SegmentResponse
¶requiredlocator locatorstartTime datetimeendTime datetimeduration numbersegmentType Enum coverage | gapoptionalbasedOn locator?
ChangeInstructionResponse
¶requiredaction string
AddChangeInstructionResponse
¶requiredlocator locatoraction Enum addelements ElementCreateRequest[]
ModifyChangeInstructionResponse
¶requiredlocator locatorstaticLocator locatoraction Enum modifyremoveCoverageTerms map<string,object>removeData map<string,object>setCoverageTerms map<string,string>setData map<string,object>
ParamsChangeInstructionResponse
¶requiredlocator locatoreffectiveTime datetimeaction Enum paramsoptionalnewPolicyEndTime datetime?preferences PreferencesResponse?triggerBillingChange boolean?billingModeChange boolean? (deprecated)
Use triggerBillingChange instead.inheritSettings boolean? (deprecated)
DeleteChangeInstructionResponse
¶requiredlocator locatoraction Enum deletestaticElementLocators locator[]
Fetches the 'local stack' of issued transactions, excluding those that have been reversed or reapplied
GET /policy/{tenantLocator}/policies/{locator}/issuedTransactions/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:PolicyTransactionListResponse
Security Group:policies  Permission:read
PolicyTransactionListResponse
¶requiredlistCompleted booleanitems PolicyTransactionResponse[]
Transaction Creation
PATCH /policy/{tenantLocator}/policies/{locator}/{transactionType}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
transactionType | path | string | required |
baseLocator | query | locator? | optional |
Request:oneOf<AddChangeInstructionCreateRequest, DeleteChangeInstructionCreateRequest, ModifyChangeInstructionCreateRequest, ParamsChangeInstructionCreateRequest>[]
Response:PolicyTransactionResponse
Security Group:policies  Permission:write
PATCH /policy/{tenantLocator}/policies/{locator}/change
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
baseLocator | query | locator? | optional |
Request:oneOf<AddChangeInstructionCreateRequest, DeleteChangeInstructionCreateRequest, ModifyChangeInstructionCreateRequest, ParamsChangeInstructionCreateRequest>[]
Response:PolicyTransactionResponse
Security Group:policies  Permission:write
PATCH /policy/{tenantLocator}/policies/{locator}/renew
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
baseLocator | query | locator? | optional |
Request:oneOf<AddChangeInstructionCreateRequest, DeleteChangeInstructionCreateRequest, ModifyChangeInstructionCreateRequest, ParamsChangeInstructionCreateRequest>[]
Response:PolicyTransactionResponse
Security Group:policies  Permission:write
PATCH /policy/{tenantLocator}/policies/{locator}/cancel
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
baseLocator | query | locator? | optional |
Response:PolicyTransactionResponse
Security Group:policies  Permission:write
PATCH /policy/{tenantLocator}/policies/{locator}/reinstate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
baseLocator | query | locator? | optional |
Response:PolicyTransactionResponse
Security Group:policies  Permission:write
AddChangeInstructionCreateRequest
¶requiredaction Enum addelements ElementCreateRequest[]
ParamsChangeInstructionCreateRequest
¶requiredeffectiveTime datetimeaction Enum paramsoptionalnewPolicyEndTime datetime?preferences PreferencesResponse?triggerBillingChange boolean?billingModeChange boolean? (deprecated)
Use triggerBillingChange instead.inheritSettings boolean? (deprecated)
ModifyChangeInstructionCreateRequest
¶requiredstaticLocator locatoraction Enum modifyremoveCoverageTerms map<string,object>removeData map<string,object>setCoverageTerms map<string,string>setData map<string,object>
DeleteChangeInstructionCreateRequest
¶requiredaction Enum deletestaticElementLocators locator[]
PATCH /policy/{tenantLocator}/policies/{locator}/reversal
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:PolicyTransactionReversalRequest
Response:PolicyTransactionResponse
Security Group:policies  Permission:write
PolicyTransactionReversalRequest
¶requiredbaseLocator locatortoTransaction locatorreverseTransactions locator[]
Updating
PATCH /policy/{tenantLocator}/transactions/{locator}/initialize
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
PUT /policy/{tenantLocator}/transactions/{locator}/elements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:ElementCreateRequest[]
Response:SegmentResponse[]
Security Group:transactions  Permission:write
PATCH /policy/{tenantLocator}/transactions/{locator}/elements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:ElementUpdateRequest
Response:SegmentResponse[]
Security Group:transactions  Permission:write
DELETE /policy/{tenantLocator}/transactions/{locator}/elements
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:locator[]
Response:SegmentResponse[]
Security Group:transactions  Permission:write
PUT /policy/{tenantLocator}/transactions/{locator}/changeInstructions
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:oneOf<AddChangeInstructionCreateRequest, DeleteChangeInstructionCreateRequest, ModifyChangeInstructionCreateRequest, ParamsChangeInstructionCreateRequest>
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
PATCH /policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
instructionLocator | path | locator | required |
Request:oneOf<AddChangeInstructionCreateRequest, DeleteChangeInstructionCreateRequest, ModifyChangeInstructionCreateRequest, ParamsChangeInstructionCreateRequest>
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
DELETE /policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
instructionLocator | path | locator | required |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
Note
Transactions can only be updated when they are in draft
state.
Validation
PATCH /policy/{tenantLocator}/transactions/{locator}/validate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
stateless | query | boolean? | optional |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
ValidationResult
¶requiredsuccess booleanoptionalvalidationItems ValidationItemResponse[]?
ValidationItemResponse
¶requiredlocator locatorelementType stringerrors string[]
Pricing
PATCH /policy/{tenantLocator}/transactions/{locator}/price
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
stateless | query | boolean? | optional |
Response:TransactionPriceResponse
Security Group:transactions  Permission:write
GET /policy/{tenantLocator}/transactions/{locator}/price
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:TransactionPriceResponse
Security Group:transactions  Permission:read
TransactionPriceResponse
¶requiredlocator locatorpolicyLocator locatoreffectiveTime datetimetransactionState Enum draft | initialized | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded | invalidated | reversedtransactionCategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregatecharges ChargeResponse[]optionalaggregatedTransactions TransactionPriceResponse[]?
Underwriting
PATCH /policy/{tenantLocator}/transactions/{locator}/underwrite
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
stateless | query | boolean? | optional |
Response:TransactionUnderwritingResponse
Security Group:transactions  Permission:write
TransactionUnderwritingResponse
¶requiredlocator locatorpolicyLocator locatoreffectiveTime datetimetransactionState Enum draft | initialized | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded | invalidated | reversedtransactionCategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregateunderwritingStatus stringaggregatedTransactions TransactionUnderwritingResponse[]underwritingFlags UnderwritingFlagResponse[]
PATCH /policy/{tenantLocator}/transactions/{locator}/underwritingFlags
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Request:UnderwritingFlagsUpdateRequest
Response:TransactionUnderwritingFlagsResponse
Security Group:transactions  Permission:write
GET /policy/{tenantLocator}/transactions/{locator}/underwritingFlags
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:TransactionUnderwritingFlagsResponse
Security Group:transactions  Permission:read
TransactionUnderwritingFlagsResponse
¶requiredtransactionLocator locatorclearedFlags UnderwritingFlagResponse[]flags UnderwritingFlagResponse[]
UnderwritingFlagResponse
¶requiredlocator locatorreferenceLocator locatorclearedBy uuidclearedTime datetimecreatedTime datetimelevel Enum info | block | decline | reject | approvenote stringreferenceType Enum quote | transactioncreatedBy uuidoptionalelementLocator locator?
Acceptance
PATCH /policy/{tenantLocator}/transactions/{locator}/accept
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
Issuance
PATCH /policy/{tenantLocator}/transactions/{locator}/issue
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
autoRebase | query | boolean? | optional |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
Documents
GET /document/{tenantLocator}/documents/transaction/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DocumentListResponse
Security Group:documents  Permission:read
GET /document/{tenantLocator}/documents/segment/{locator}/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:DocumentListResponse
Security Group:documents  Permission:read
DocumentInstanceResponse
¶requiredlocator locatorreferenceLocator locatordocumentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionErrorexternal booleanreferenceType Enum quote | policy | invoice | transaction | segment | termcreatedAt datetimemetadata map<string,object>renderingData map<string,object>optionalpolicyLocator locator?termLocator locator?transactionLocator locator?segmentLocator locator?referenceDocumentLocator locator?staticName string?name string?category string?documentFormat Enum? text | html | pdf | jpg | jpeg | doc | docx | xls | xlsx | csv | txt | zipprocessingErrors string?readyAt datetime?createdBy uuid?
Transaction Details
GET /policy/{tenantLocator}/transactions/{locator}/preferences
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:PreferencesResponse
Security Group:transactions  Permission:read
GET /policy/{tenantLocator}/transactions/{locator}/affectedTransactions
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:AffectedTransaction[]
Security Group:transactions  Permission:read
AffectedTransaction
¶requiredlocator locatoraction Enum reversed | reapplied | invalidated
Atypical States and Operations
PATCH /policy/{tenantLocator}/transactions/{locator}/reset
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
resetToDraft | query | boolean? | optional |
Request:ResetOptions
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
ResetOptions
¶requireddeleteAllAutomaticDocuments booleanresetAllUnderwritingFlags booleanresetFlagsAction Enum clear | deletedeleteDocuments locator[]resetFlags locator[]
Note
If the query parameter resetToDraft
is true
, then the transaction will revert to draft
state and the generated segment data, including elements and data, will be discarded. If false
(the default), then the transaction will revert to initialized
state and the segment data will be retained. This is useful to preserve the locator data for generated elements.
PATCH /policy/{tenantLocator}/transactions/{locator}/refuse
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
PATCH /policy/{tenantLocator}/transactions/{locator}/discard
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:PolicyTransactionResponse
Security Group:transactions  Permission:write
Deprecated Items
This endpoint will be removed in a future release.
GET /policy/{tenantLocator}/transactions/{locator}/segments/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
Response:SegmentResponse[]
Security Group:transactions  Permission:read
This endpoint will be removed in a future release.
GET /policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | locator | required |
segmentLocator | path | locator | required |
Response:SegmentResponse
Security Group:transactions  Permission:read