Policy Transactions API

Action	Endpoint
Fetch a Transaction	GET/policy/{tenantLocator}/transactions/{locator}
Fetch Policy Transaction With Updated Changes	GET/policy/{tenantLocator}/transactions/{locator}/elements/changes
Fetch Transaction Branches by Policy	GET/policy/{tenantLocator}/policies/{locator}/branches
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
Get a stateless validation preview for a hypothetical transaction	PATCH/policy/{tenantLocator}/policies/{locator}/{transactionType}/validatePreview
Price a Transaction	PATCH/policy/{tenantLocator}/transactions/{locator}/price
Fetch Pricing for a Transaction	GET/policy/{tenantLocator}/transactions/{locator}/price
Get a stateless price preview for a hypothetical transaction	PATCH/policy/{tenantLocator}/policies/{locator}/{transactionType}/pricePreview
Underwrite a Transaction	PATCH/policy/{tenantLocator}/transactions/{locator}/underwrite
Get a stateless underwriting preview for a hypothetical transaction	PATCH/policy/{tenantLocator}/policies/{locator}/{transactionType}/underwritePreview
Update a Transaction's Underwriting Flags	PATCH/policy/{tenantLocator}/transactions/{locator}/underwritingFlags
Fetch Underwriting Flags	GET/policy/{tenantLocator}/transactions/{locator}/underwritingFlags
Add Approve Level Underwriting Flag for Transaction	POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/approve
Add Decline Level Underwriting Flag for Transaction	POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/decline
Add Block Level Underwriting Flag for Transaction	POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/block
Add Reject Level Underwriting Flag for Transaction	POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/reject
Add Info Level Underwriting Flag for Transaction	POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/info
Clear Approve Level Underwriting Flag for Transaction	DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/approve/{flagLocator}
Clear Decline Level Underwriting Flag for Transaction	DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/decline/{flagLocator}
Clear Block Level Underwriting Flag for Transaction	DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/block/{flagLocator}
Clear Reject Level Underwriting Flag for Transaction	DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/reject/{flagLocator}
Clear Info Level Underwriting Flag for Transaction	DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/info/{flagLocator}
Accept a Transaction	PATCH/policy/{tenantLocator}/transactions/{locator}/accept
Issue a Transaction	PATCH/policy/{tenantLocator}/transactions/{locator}/issue
Fetch Preferences For ATransaction	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
Invoke the precommit plugin for a draft or initialized transaction	PATCH/policy/{tenantLocator}/transactions/{locator}/precommit
Fetch Affected Transactions For List Endpoint	GET/policy/{tenantLocator}/transactions/{locator}/affectedTransactions/list
Fetch Transaction Segments	GET/policy/{tenantLocator}/transactions/{locator}/segments/list
Fetch Policy Segment Ex	GET/policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator}

Main Flow

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

Fetch a TransactionfetchTransaction

GET/policy/{tenantLocator}/transactions/{locator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permission:

read

PolicyTransactionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`staticLocator`	`ulid`	Equals the locator of the first transaction this is based on.
`policyLocator`	`ulid`
`termLocator`	`ulid`
`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 properties

Property	Type	Description
`aggregateTransactionLocator`	`ulid?`
`baseTransactionLocator`	`ulid?`
`reapplicationOfLocator`	`ulid?`
`issuedTime`	`datetime?`
`acceptedTime`	`datetime?`
`anonymizedAt`	`datetime?`
`expirationTime`	`datetime?`
`maskingLevel`	`Enum? none \| level1 \| level2`
`preferences`	`PreferencesResponse?`
`underwritingStatus`	`string?`
`validationResult`	`ValidationResult?`
`aggregatedTransactions`	`PolicyTransactionResponse[]?`
`changeInstructions`	`object[]?`

The staticLocator of the transaction equals the locator for the original version of a transaction. When transactions are reapplied, as in out-of-sequence transactions, the staticLocator will equal the staticLocator of the transaction this it is based on.

PreferencesResponse

Properties

Property	Type	Description
`installmentPreferences`	`InstallmentPreferences?`

InstallmentPreferences

Required properties

Property	Type	Description
`installmentWeights`	`number[]`

Optional properties

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

Fetch Policy Transaction With Updated Changes

Fetch Policy Transaction With Updated ChangesfetchPolicyTransactionWithUpdatedChanges

GET/policy/{tenantLocator}/transactions/{locator}/elements/changes

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permission:

read

Fetch Transaction Branches by Policy

Fetch Transaction Branches by PolicygetTransactionsBranchesByPolicy

GET/policy/{tenantLocator}/policies/{locator}/branches

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:map<string, PolicyTransactionResponse[]>

Security Group:policies

Permission:

read

Fetch Policy Segment for a Transaction

Fetch Policy Segment for a TransactionfetchTransactionSegment

GET/policy/{tenantLocator}/transactions/{locator}/segment

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:SegmentResponse

Security Group:transactions

Permission:

read

Fetch a Policy Segment

Fetch a Policy SegmentfetchPolicySegment

GET/policy/{tenantLocator}/transactions/segments/{segmentLocator}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`segmentLocator`	path	`ulid`	Yes

Response:SegmentResponse

Security Group:transactions

Permission:

read

SegmentResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`transactionLocator`	`ulid`
`startTime`	`datetime`
`endTime`	`datetime`
`duration`	`number`
`element`	`ElementResponse`	The root element in the hierarchy
`segmentType`	`Enum coverage \| gap`

Optional properties

Property	Type	Description
`anonymizedAt`	`datetime?`
`basedOn`	`ulid?`
`producerInfo`	`ProducerInfo?`

ProducerInfo

Properties

Property	Type	Description
`producerCode`	`string?`
`producerCodeOfRecord`	`string?`

ChangeInstructionResponse

Required properties

Property	Type	Description
`action`	`string`

AddChangeInstructionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`action`	`Enum add`
`elements`	`ElementCreateRequest[]`

ModifyChangeInstructionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`staticLocator`	`ulid`
`action`	`Enum modify`
`removeCoverageTerms`	`map<string, object>`
`removeData`	`map<string, object>`
`setCoverageTerms`	`map<string, object>`
`setData`	`map<string, object>`

ParamsChangeInstructionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`effectiveTime`	`datetime`
`action`	`Enum params`

Optional properties

Property	Type	Description
`expirationTime`	`datetime?`
`newPolicyEndTime`	`datetime?`
`preferences`	`PreferencesResponse?`
`triggerBillingChange`	`boolean?`
`billingModeChange`	`boolean?`Deprecated	Use triggerBillingChange instead.
`inheritSettings`	`boolean?`Deprecated

DeleteChangeInstructionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`action`	`Enum delete`
`staticElementLocators`	`ulid[]`

ProducersChangeInstructionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`action`	`Enum producers`

Optional properties

Property	Type	Description
`clearProducerCode`	`boolean?`
`revertProducerCodeOfRecord`	`boolean?`
`setProducerCode`	`string?`
`setProducerCodeOfRecord`	`string?`

MigrateChangeInstructionResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`action`	`Enum migrate`

Optional properties

Property	Type	Description
`configVersionLocator`	`ulid?`

Fetch Issued Transactions

Fetch Issued TransactionsfetchIssuedTransactions

GET/policy/{tenantLocator}/policies/{locator}/issuedTransactions/list

Fetches the 'local stack' of issued transactions, excluding those that have been reversed or reapplied

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.

Response:PolicyTransactionListResponse

Security Group:policies

Permission:

read

PolicyTransactionListResponse

Required properties

Property	Type	Description
`listCompleted`	`boolean`
`items`	`PolicyTransactionResponse[]`

Transaction Creation

Create a Transaction

Create a TransactioncreatePolicyTransaction

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`transactionType`	path	`string`	Yes
`baseLocator`	query	`ulid?`	No

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>[]

Response:PolicyTransactionResponse

Security Group:policies

Permission:

write

Create a Policy Change Transaction

Create a Policy Change TransactionchangePolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`baseLocator`	query	`ulid?`	No

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>[]

Response:PolicyTransactionResponse

Security Group:policies

Permission:

write

Create a Renewal Transaction

Create a Renewal TransactionrenewPolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`baseLocator`	query	`ulid?`	No

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>[]

Response:PolicyTransactionResponse

Security Group:policies

Permission:

write

Create a Cancellation Transaction

Create a Cancellation TransactioncancelPolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`baseLocator`	query	`ulid?`	No

Request:ParamsChangeInstructionCreateRequest

Response:PolicyTransactionResponse

Security Group:policies

Permission:

write

Create a Reinstatement Transaction

Create a Reinstatement TransactionreinstatePolicy

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

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`baseLocator`	query	`ulid?`	No

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>[]

Response:PolicyTransactionResponse

Security Group:policies

Permission:

write

AddChangeInstructionCreateRequest

Required properties

Property	Type	Description
`action`	`Enum add`
`elements`	`ElementCreateRequest[]`

ParamsChangeInstructionCreateRequest

Required properties

Property	Type	Description
`effectiveTime`	`datetime`
`action`	`Enum params`

Optional properties

Property	Type	Description
`expirationTime`	`datetime?`
`newPolicyEndTime`	`datetime?`
`preferences`	`PreferencesResponse?`
`triggerBillingChange`	`boolean?`
`billingModeChange`	`boolean?`Deprecated	Use triggerBillingChange instead.
`inheritSettings`	`boolean?`Deprecated

ModifyChangeInstructionCreateRequest

Required properties

Property	Type	Description
`staticLocator`	`ulid`
`action`	`Enum modify`
`removeCoverageTerms`	`map<string, object>`
`removeData`	`map<string, object>`
`setCoverageTerms`	`map<string, object>`
`setData`	`map<string, object>`

DeleteChangeInstructionCreateRequest

Required properties

Property	Type	Description
`action`	`Enum delete`
`staticElementLocators`	`ulid[]`

ProducersChangeInstructionCreateRequest

Required properties

Property	Type	Description
`action`	`Enum producers`

Optional properties

Property	Type	Description
`clearProducerCode`	`boolean?`
`revertProducerCodeOfRecord`	`boolean?`
`setProducerCode`	`string?`
`setProducerCodeOfRecord`	`string?`

MigrateChangeInstructionCreateRequest

Required properties

Property	Type	Description
`action`	`Enum migrate`

Optional properties

Property	Type	Description
`configVersionLocator`	`ulid?`

Create a Reversal Transaction

Create a Reversal TransactionreversePolicyChange

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

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:PolicyTransactionReversalRequest

Response:PolicyTransactionResponse

Security Group:policies

Permission:

write

PolicyTransactionReversalRequest

Required properties

Property	Type	Description
`baseLocator`	`ulid`
`toTransaction`	`ulid`
`reverseTransactions`	`ulid[]`

Updating

Initialize Transaction

Initialize TransactioninitializeTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/initialize

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,initialize

Add Elements To Policy With Transaction

Add Elements To Policy With TransactionaddElementsToPolicyWithTransaction

PUT/policy/{tenantLocator}/transactions/{locator}/elements

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:ElementCreateRequest[]

Response:SegmentResponse[]

Security Group:transactions

Permissions:

write,elements-add

Update Elements In Policy With Transaction

Update Elements In Policy With TransactionupdateElementsInPolicyWithTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/elements

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:ElementUpdateRequest

Response:SegmentResponse[]

Security Group:transactions

Permissions:

write,elements-update

Remove Elements From Policy With Transaction

Remove Elements From Policy With TransactionremoveElementsFromPolicyWithTransaction

DELETE/policy/{tenantLocator}/transactions/{locator}/elements

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:ulid[]

Response:SegmentResponse[]

Security Group:transactions

Permissions:

write,elements-delete

Add a Change Instruction to a Transaction

Add a Change Instruction to a TransactioncreatePolicyChangeInstruction

PUT/policy/{tenantLocator}/transactions/{locator}/changeInstructions

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,change-instruction-add

Update One of a Transaction's Change Instructions

Update One of a Transaction's Change InstructionsupdateChangeInstruction

PATCH/policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`instructionLocator`	path	`ulid`	Yes

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,change-instruction-update

Delete a Change Instruction from a Transaction

Delete a Change Instruction from a TransactiondeleteChangeInstructionFromTransaction

DELETE/policy/{tenantLocator}/transactions/{locator}/changeInstructions/{instructionLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`instructionLocator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,change-instruction-delete

Transactions can only be updated when they are in draft state.

Validation

Validate a Transaction

Validate a TransactionvalidateTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/validate

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`stateless`	query	`boolean?`	No

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,validate

ValidationResult

Required properties

Property	Type	Description
`success`	`boolean`

Optional properties

Property	Type	Description
`validationItems`	`ValidationItemResponse[]?`

ValidationItemResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`elementType`	`string`
`errors`	`string[]`

Get a stateless validation preview for a hypothetical transaction

Get a stateless validation preview for a hypothetical transactiontransactionValidatePreview

PATCH/policy/{tenantLocator}/policies/{locator}/{transactionType}/validatePreview

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`transactionType`	path	`string`	Yes
`baseLocator`	query	`ulid?`	No

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>[]

Response:PolicyTransactionResponse

Security Group:policies

Permission:

read

Pricing

Price a Transaction

Price a TransactionpriceTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/price

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`stateless`	query	`boolean?`	No

Response:TransactionPriceResponse

Security Group:transactions

Permissions:

write,price

Fetch Pricing for a Transaction

Fetch Pricing for a TransactionfetchTransactionPricing

GET/policy/{tenantLocator}/transactions/{locator}/price

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:TransactionPriceResponse

Security Group:transactions

Permission:

read

TransactionPriceResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`policyLocator`	`ulid`
`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`	`PolicyChargeResponse[]`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`
`aggregatedTransactions`	`TransactionPriceResponse[]?`

PolicyChargeResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`elementLocator`	`ulid`
`elementStaticLocator`	`ulid`
`amount`	`number`
`chargeCategory`	`Enum none \| premium \| tax \| fee \| credit \| invoiceFee \| cededPremium \| nonFinancial \| surcharge`
`chargeType`	`string`
`handling`	`Enum flat \| normal \| retention`
`invoicing`	`Enum scheduled \| next \| immediate`
`rate`	`number`
`referenceRate`	`number`

Optional properties

Property	Type	Description
`reversalOfLocator`	`ulid?`
`rateDifference`	`number?`
`tag`	`string?`

Get a stateless price preview for a hypothetical transaction

Get a stateless price preview for a hypothetical transactiontransactionPricePreview

PATCH/policy/{tenantLocator}/policies/{locator}/{transactionType}/pricePreview

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`transactionType`	path	`string`	Yes
`baseLocator`	query	`ulid?`	No

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>[]

Response:TransactionPriceResponse

Security Group:policies

Permission:

read

Underwriting

Underwrite a Transaction

Underwrite a TransactionunderwriteTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/underwrite

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`stateless`	query	`boolean?`	No

Response:TransactionUnderwritingResponse

Security Group:transactions

Permissions:

write,underwrite

TransactionUnderwritingResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`policyLocator`	`ulid`
`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`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`
`aggregatedTransactions`	`TransactionUnderwritingResponse[]?`
`underwritingFlags`	`UnderwritingFlagResponse[]?`

Get a stateless underwriting preview for a hypothetical transaction

Get a stateless underwriting preview for a hypothetical transactionunderwritePreview

PATCH/policy/{tenantLocator}/policies/{locator}/{transactionType}/underwritePreview

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`transactionType`	path	`string`	Yes
`baseLocator`	query	`ulid?`	No

Request:

oneOf<AddChangeInstructionCreateRequest,DeleteChangeInstructionCreateRequest,MigrateChangeInstructionCreateRequest,ModifyChangeInstructionCreateRequest,ParamsChangeInstructionCreateRequest,ProducersChangeInstructionCreateRequest>[]

Response:TransactionUnderwritingResponse

Security Group:policies

Permission:

read

Underwriting Flags

Update a Transaction's Underwriting Flags

Update a Transaction's Underwriting FlagsupdateUnderwritingFlagsForPolicyTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/underwritingFlags

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagsUpdateRequest

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permission:

write

Fetch Underwriting Flags

Fetch Underwriting FlagsfetchUnderwritingFlagsForTransaction

GET/policy/{tenantLocator}/transactions/{locator}/underwritingFlags

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permission:

read

TransactionUnderwritingFlagsResponse

Required properties

Property	Type	Description
`transactionLocator`	`ulid`
`clearedFlags`	`UnderwritingFlagResponse[]`
`flags`	`UnderwritingFlagResponse[]`

UnderwritingFlagResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`clearedBy`	`uuid`
`clearedTime`	`datetime`
`createdTime`	`datetime`
`level`	`Enum info \| block \| decline \| reject \| approve`
`note`	`string`
`referenceType`	`Enum quote \| transaction`
`tag`	`string`
`taskCreationResponse`	`TaskCreationResponse`
`createdBy`	`uuid`

Optional properties

Property	Type	Description
`elementLocator`	`ulid?`

Add Approve Level Underwriting Flag for Transaction

Add Approve Level Underwriting Flag for TransactionaddApproveUnderwritingFlagsForTransaction

POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/approve

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,approve-add

Add Decline Level Underwriting Flag for Transaction

Add Decline Level Underwriting Flag for TransactionaddDeclineUnderwritingFlagsForTransaction

POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/decline

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,decline-add

Add Block Level Underwriting Flag for Transaction

Add Block Level Underwriting Flag for TransactionaddBlockUnderwritingFlagsForTransaction

POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/block

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,block-add

Add Reject Level Underwriting Flag for Transaction

Add Reject Level Underwriting Flag for TransactionaddRejectUnderwritingFlagsForTransaction

POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/reject

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,reject-add

Add Info Level Underwriting Flag for Transaction

Add Info Level Underwriting Flag for TransactionaddInfoUnderwritingFlagsForTransaction

POST/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/info

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Request:UnderwritingFlagCreateRequest

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,info-add

Clear Approve Level Underwriting Flag for Transaction

Clear Approve Level Underwriting Flag for TransactionclearApproveUnderwritingFlagsForTransaction

DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/approve/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,approve-clear

Clear Decline Level Underwriting Flag for Transaction

Clear Decline Level Underwriting Flag for TransactionclearDeclineUnderwritingFlagsForTransaction

DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/decline/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,decline-clear

Clear Block Level Underwriting Flag for Transaction

Clear Block Level Underwriting Flag for TransactionclearBlockUnderwritingFlagsForTransaction

DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/block/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,block-clear

Clear Reject Level Underwriting Flag for Transaction

Clear Reject Level Underwriting Flag for TransactionclearRejectUnderwritingFlagsForTransaction

DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/reject/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,reject-clear

Clear Info Level Underwriting Flag for Transaction

Clear Info Level Underwriting Flag for TransactionclearInfoUnderwritingFlagsForTransaction

DELETE/policy/{tenantLocator}/transactions/{locator}/underwritingFlags/info/{flagLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`flagLocator`	path	`ulid`	Yes

Response:TransactionUnderwritingFlagsResponse

Security Group:transactions

Permissions:

write,info-clear

Acceptance

Accept a Transaction

Accept a TransactionacceptTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/accept

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,accept

Issuance

Issue a Transaction

Issue a TransactionissueTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/issue

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`autoRebase`	query	`boolean?`	No

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,issue

Documents

Fetch Documents For Transaction

Fetch Documents For TransactionfetchDocumentsForTransaction

GET/document/{tenantLocator}/documents/transaction/{locator}/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.
`suppressRenderingData`	query	`boolean?`	No

Response:DocumentListResponse

Security Group:documents

Permission:

read

Fetch Documents For Segment

Fetch Documents For SegmentfetchDocumentsForSegment

GET/document/{tenantLocator}/documents/segment/{locator}/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No	When false, returns a bare array.
`suppressRenderingData`	query	`boolean?`	No

Response:DocumentListResponse

Security Group:documents

Permission:

read

DocumentInstanceResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`referenceLocator`	`ulid`
`documentInstanceState`	`Enum draft \| dataReady \| ready \| dataError \| renderError \| conversionError`
`documentFormat`	`Enum csv \| doc \| docx \| html \| jpeg \| jpg \| pdf \| text \| txt \| xls \| xlsx \| zip`
`external`	`boolean`
`referenceType`	`Enum quote \| policy \| invoice \| transaction \| segment \| term`
`createdAt`	`datetime`
`consolidatedFrom`	`ulid[]`
`consolidatedTo`	`ulid[]`
`metadata`	`map<string, object>`
`renderingData`	`map<string, object>`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`termLocator`	`ulid?`
`transactionLocator`	`ulid?`
`segmentLocator`	`ulid?`
`referenceDocumentLocator`	`ulid?`
`staticName`	`string?`
`name`	`string?`
`category`	`string?`
`copyOnIssuance`	`boolean?`
`processingErrors`	`string?`
`readyAt`	`datetime?`
`createdBy`	`uuid?`

Transaction Details

Fetch Preferences For ATransaction

Fetch Preferences For A TransactionfetchPreferencesForATransaction

GET/policy/{tenantLocator}/transactions/{locator}/preferences

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PreferencesResponse

Security Group:transactions

Permission:

read

Fetch Affected Transactions

Fetch Affected TransactionsfetchAffectedTransactions

GET/policy/{tenantLocator}/transactions/{locator}/affectedTransactions

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:AffectedTransaction[]

Security Group:transactions

Permission:

read

AffectedTransaction

Required properties

Property	Type	Description
`locator`	`ulid`
`action`	`Enum reversed \| reapplied \| invalidated`

Atypical States and Operations

Reset a Transaction

Reset a TransactionresetTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/reset

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`resetToDraft`	query	`boolean?`	No

Request:ResetOptions

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,reset

ResetOptions

Required properties

Property	Type	Description
`deleteAllAutomaticDocuments`	`boolean`
`discardSchedules`	`boolean`
`resetAllUnderwritingFlags`	`boolean`
`resetFlagsAction`	`Enum clear \| delete`
`deleteDocuments`	`ulid[]`
`resetFlags`	`ulid[]`

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

Refuse a TransactionrefuseTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/refuse

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,refuse

Discard a Transaction

Discard a TransactiondiscardTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/discard

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,discard

Invoke the precommit plugin for a draft or initialized transaction

Invoke the precommit plugin for a draft or initialized transactionprecommitTransaction

PATCH/policy/{tenantLocator}/transactions/{locator}/precommit

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:PolicyTransactionResponse

Security Group:transactions

Permissions:

write,precommit

Deprecated Items

Fetch Affected Transactions For List Endpoint

Fetch Affected Transactions For List EndpointfetchAffectedTransactionsForListEndpointDeprecated

GET/policy/{tenantLocator}/transactions/{locator}/affectedTransactions/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:AffectedTransaction[]

Security Group:transactions

Permission:

read

Fetch Transaction Segments

Fetch Transaction SegmentsfetchTransactionSegmentsDeprecated

GET/policy/{tenantLocator}/transactions/{locator}/segments/list

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes

Response:SegmentResponse[]

Security Group:transactions

Permission:

read

Fetch Policy Segment Ex

Fetch Policy Segment ExfetchPolicySegmentExDeprecated

GET/policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`segmentLocator`	path	`ulid`	Yes

Response:SegmentResponse

Security Group:transactions

Permission:

read

Policy Transactions API

On this page