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

Fetch a Transaction

fetchTransaction

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

required
locator locator
policyLocator locator
termLocator locator
effectiveTime datetime
transactionState Enum draft | initialized | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded | invalidated | reversed
transactionCategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
transactionType string
createdAt datetime
createdBy uuid

optional
aggregateTransactionLocator 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

optional
billingPreferences BillingPreferences?
installmentPreferences InstallmentPreferences?

BillingPreferences

optional
billingPlanName string?
billingLevel Enum? account | inherit | policy

InstallmentPreferences

required
installmentWeights number[]

optional
installmentPlanName string?
anchorMode Enum? generateDay | termStartDay | dueDay
anchorTime datetime?
anchorType Enum? none | dayOfMonth | anchorTime | dayOfWeek | weekOfMonth
cadence Enum? none | fullPay | weekly | everyOtherWeek | monthly | quarterly | semiannually | annually | thirtyDays | everyNDays
dayOfMonth int?
dayOfWeek Enum? monday | tuesday | wednesday | thursday | friday | saturday | sunday
dueLeadDays int?
generateLeadDays int?
maxInstallmentsPerTerm int?
weekOfMonth Enum? none | first | second | third | fourth | fifth

Fetch Policy Transaction with Updated Changes

fetchPolicyTransactionWithUpdatedChanges

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

Fetch Policy Segment for a Transaction

fetchTransactionSegment

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

Fetch a Policy Segment

fetchPolicySegment

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

required
locator locator
transactionLocator locator
startTime datetime
endTime datetime
duration number
element ElementResponse
The root element in the hierarchy
segmentType Enum coverage | gap

optional
basedOn locator?

ChangeInstructionResponse

required
action string

AddChangeInstructionResponse

required
locator locator
action Enum add
elements ElementCreateRequest[]

ModifyChangeInstructionResponse

required
locator locator
staticLocator locator
action Enum modify
removeCoverageTerms map<string,object>
removeData map<string,object>
setCoverageTerms map<string,string>
setData map<string,object>

ParamsChangeInstructionResponse

required
locator locator
effectiveTime datetime
action Enum params

optional
newPolicyEndTime datetime?
preferences PreferencesResponse?
triggerBillingChange boolean?
billingModeChange boolean? (deprecated)
Use triggerBillingChange instead.
inheritSettings boolean? (deprecated)

DeleteChangeInstructionResponse

required
locator locator
action Enum delete
staticElementLocators locator[]

Fetch Issued Transactions

fetchIssuedTransactions

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

required
listCompleted boolean
items PolicyTransactionResponse[]

Transaction Creation

Create a Transaction

createPolicyTransaction

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

Create a Policy Change Transaction

changePolicy

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

Create a Renewal Transaction

renewPolicy

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

Create a Cancellation Transaction

cancelPolicy

PATCH /policy/{tenantLocator}/policies/{locator}/cancel

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required
baseLocator	query	locator?	optional

Request:ParamsChangeInstructionCreateRequest
Response:PolicyTransactionResponse
Security Group:policies   Permission:write

Create a Reinstatement Transaction

reinstatePolicy

PATCH /policy/{tenantLocator}/policies/{locator}/reinstate

Request Parameters:

Name	Position	Type	Required
tenantLocator	path	uuid	required
locator	path	locator	required
baseLocator	query	locator?	optional

Request:ParamsChangeInstructionCreateRequest
Response:PolicyTransactionResponse
Security Group:policies   Permission:write

AddChangeInstructionCreateRequest

required
action Enum add
elements ElementCreateRequest[]

ParamsChangeInstructionCreateRequest

required
effectiveTime datetime
action Enum params

optional
newPolicyEndTime datetime?
preferences PreferencesResponse?
triggerBillingChange boolean?
billingModeChange boolean? (deprecated)
Use triggerBillingChange instead.
inheritSettings boolean? (deprecated)

ModifyChangeInstructionCreateRequest

required
staticLocator locator
action Enum modify
removeCoverageTerms map<string,object>
removeData map<string,object>
setCoverageTerms map<string,string>
setData map<string,object>

DeleteChangeInstructionCreateRequest

required
action Enum delete
staticElementLocators locator[]

Create a Reversal Transaction

reversePolicyChange

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

required
baseLocator locator
toTransaction locator
reverseTransactions locator[]

Updating

Initialize Transaction

initializeTransaction

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

Add Elements To Policy with Transaction

addElementsToPolicyWithTransaction

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

Update Elements In Policy with Transaction

updateElementsInPolicyWithTransaction

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

Remove Elements From Policy with Transaction

removeElementsFromPolicyWithTransaction

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

Add a Change Instruction to a Transaction

createPolicyChangeInstruction

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

Update One of a Transaction's Change Instructions

updateChangeInstruction

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 a Change Instruction from a Transaction

deleteChangeInstructionFromTransaction

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

Validate a Transaction

validateTransaction

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

required
success boolean

optional
validationItems ValidationItemResponse[]?

ValidationItemResponse

required
locator locator
elementType string
errors string[]

Pricing

Price a Transaction

priceTransaction

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

Fetch Pricing for a Transaction

fetchTransactionPricing

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

required
locator locator
policyLocator locator
effectiveTime datetime
transactionState Enum draft | initialized | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded | invalidated | reversed
transactionCategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
charges ChargeResponse[]

optional
aggregatedTransactions TransactionPriceResponse[]?

Underwriting

Underwrite a Transaction

underwriteTransaction

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

required
locator locator
policyLocator locator
effectiveTime datetime
transactionState Enum draft | initialized | validated | earlyUnderwritten | priced | underwritten | accepted | issued | underwrittenBlocked | declined | rejected | refused | discarded | invalidated | reversed
transactionCategory Enum issuance | change | renewal | cancellation | reinstatement | reversal | aggregate
underwritingStatus string
aggregatedTransactions TransactionUnderwritingResponse[]
underwritingFlags UnderwritingFlagResponse[]

Update a Transaction's Underwriting Flags

updateUnderwritingFlagsForPolicyTransaction

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

Fetch Underwriting Flags

fetchUnderwritingFlagsForTransaction

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

required
transactionLocator locator
clearedFlags UnderwritingFlagResponse[]
flags UnderwritingFlagResponse[]

UnderwritingFlagResponse

required
locator locator
referenceLocator locator
clearedBy uuid
clearedTime datetime
createdTime datetime
level Enum info | block | decline | reject | approve
note string
referenceType Enum quote | transaction
createdBy uuid

optional
elementLocator locator?

Acceptance

Accept a Transaction

acceptTransaction

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

Issue a Transaction

issueTransaction

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

Fetch Documents for Transaction

fetchDocumentsForTransaction

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

Fetch Documents for Segment

fetchDocumentsForSegment

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

required
locator locator
referenceLocator locator
documentInstanceState Enum draft | dataReady | ready | dataError | renderError | conversionError
external boolean
referenceType Enum quote | policy | invoice | transaction | segment | term
createdAt datetime
metadata map<string,object>
renderingData map<string,object>

optional
policyLocator 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 | zip
processingErrors string?
readyAt datetime?
createdBy uuid?

Transaction Details

Fetch Preferences for a Transaction

fetchPreferencesForATransaction

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

Fetch Affected Transactions

fetchAffectedTransactions

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

required
locator locator
action Enum reversed | reapplied | invalidated

Atypical States and Operations

Reset a Transaction

resetTransaction

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

required
deleteAllAutomaticDocuments boolean
resetAllUnderwritingFlags boolean
resetFlagsAction Enum clear | delete
deleteDocuments 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.

Refuse a Transaction

refuseTransaction

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

Discard a Transaction

discardTransaction

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

Fetch Transaction Segments

Deprecated

fetchTransactionSegments

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

Fetch Policy Segment Ex

Deprecated

fetchPolicySegmentEx

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