Accounts API

Action	Endpoint
Fetch an Account	GET/policy/{tenantLocator}/accounts/{locator}
Fetch Multiple Accounts	GET/policy/{tenantLocator}/accounts/list
Create an Account	POST/policy/{tenantLocator}/accounts
Update Account	PATCH/policy/{tenantLocator}/accounts/{locator}
Update Account and Replace Data	PUT/policy/{tenantLocator}/accounts/{locator}
Validate an Account	PATCH/policy/{tenantLocator}/accounts/{locator}/validate
Add contact	POST/policy/{tenantLocator}/accounts/{accountLocator}/contacts
Delete contact	DELETE/policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}
Update contact	PATCH/policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}
Fetch contacts	GET/policy/{tenantLocator}/accounts/{accountLocator}/contacts
Fetch Policies for an Account	GET/policy/{tenantLocator}/accounts/{locator}/policies/list
Fetch Quotes for an Account	GET/policy/{tenantLocator}/accounts/{locator}/quotes/list
Fetch Policy Snapshots For An Account	GET/policy/{tenantLocator}/accounts/{locator}/policies/snapshot/list
Update Billing Level For An Account	PATCH/policy/{tenantLocator}/accounts/{locator}/billingLevel
Fetch Accounts With Number	GET/policy/{tenantLocator}/accounts/numbers/{accountNumber}
Set Account Number	POST/policy/{tenantLocator}/accounts/{locator}/number/set
Generate Account Number	POST/policy/{tenantLocator}/accounts/{locator}/number/generate

Fetch

Fetch an Account

Fetch an AccountfetchAccount

GET/policy/{tenantLocator}/accounts/{locator}

Parameters

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

Response:AccountResponse

Security Group:accounts

Permission:

read

AccountResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountState`	`Enum draft \| validated \| discarded`
`accountNumber`	`string`
`billingLevel`	`Enum account \| inherit \| policy`
`type`	`string`	One of the configured Account Types
`data`	`map<string, object>`
`createdAt`	`datetime`
`createdBy`	`uuid`
`contacts`	`ContactRoles[]`
`state`	`Enum draft \| validated \| discarded`Deprecated

Optional properties

Property	Type	Description
`region`	`string?`
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`excessCreditPlanName`	`string?`
`invoicingPlanName`	`string?`
`paymentExecutionRetryPlanName`	`string?`
`shortfallTolerancePlanName`	`string?`
`timezone`	`string?`
`anonymizedAt`	`datetime?`
`invoiceDocument`	`string?`
`preferences`	`PreferencesResponse?`
`validationResult`	`ValidationResult?`

Fetch Multiple Accounts

Fetch Multiple AccountsfetchMultipleAccounts

GET/policy/{tenantLocator}/accounts/list

Parameters

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

Response:AccountListResponse

Security Group:accounts

Permissions:

read,list

AccountListResponse

Required properties

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

Account Creation

Create an Account

Create an AccountcreateAccount

POST/policy/{tenantLocator}/accounts

Parameters

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

Request:AccountCreateRequest

Response:AccountResponse

Security Group:accounts

Permission:

write

AccountCreateRequest

Required properties

Property	Type	Description
`type`	`string`	One of the configured Account Types

Optional properties

Property	Type	Description
`region`	`string?`
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`excessCreditPlanName`	`string?`
`invoicingPlanName`	`string?`
`paymentExecutionRetryPlanName`	`string?`
`shortfallTolerancePlanName`	`string?`
`timezone`	`string?`
`autoValidate`	`boolean?`
`billingLevel`	`Enum? account \| inherit \| policy`
`invoiceDocument`	`string?`
`preferences`	`PreferencesResponse?`
`data`	`map<string, object>?`
`contacts`	`ContactRoles[]?`

ContactRoles

Required properties

Property	Type	Description
`contactLocator`	`ulid`
`roles`	`string[]`

Updating

Update Account

Update AccountupdateAccount

PATCH/policy/{tenantLocator}/accounts/{locator}

Updates the account and individual data extensions.

Parameters

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

Request:AccountUpdateRequest

Response:AccountResponse

Security Group:accounts

Permission:

write

AccountUpdateRequest

Required properties

Property	Type	Description
`autoRenewalPlanName`	`string`
`delinquencyPlanName`	`string`
`excessCreditPlanName`	`string`
`invoicingPlanName`	`string`
`paymentExecutionRetryPlanName`	`string`
`shortfallTolerancePlanName`	`string`
`timezone`	`string`
`autoValidate`	`boolean`
`billingLevel`	`Enum account \| inherit \| policy`
`invoiceDocument`	`string`
`preferences`	`PreferencesResponse`
`type`	`string`	One of the configured Account Types
`removeData`	`map<string, object>`
`setData`	`map<string, object>`

Update Account and Replace Data

Update Account and Replace DataupdateAccountReplaceData

PUT/policy/{tenantLocator}/accounts/{locator}

Updates the account and replaces all existing data extensions with the new data.

Parameters

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

Request:AccountUpdateReplaceDataRequest

Response:AccountResponse

Security Group:accounts

Permission:

write

This version of updateAccount replaces all extension data for the account, rather than just updating individual properties.

AccountUpdateReplaceDataRequest

Required properties

Property	Type	Description
`type`	`string`	One of the configured Account Types

Optional properties

Property	Type	Description
`region`	`string?`
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`excessCreditPlanName`	`string?`
`invoicingPlanName`	`string?`
`paymentExecutionRetryPlanName`	`string?`
`shortfallTolerancePlanName`	`string?`
`timezone`	`string?`
`autoValidate`	`boolean?`
`billingLevel`	`Enum? account \| inherit \| policy`
`invoiceDocument`	`string?`
`preferences`	`PreferencesResponse?`
`data`	`map<string, object>?`
`contacts`	`ContactRoles[]?`

Validation

Validate an Account

Validate an AccountvalidateAccount

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

Parameters

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

Response:AccountResponse

Security Group:accounts

Permission:

write

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[]`

Contact Management

Add contact

Add contactaddAccountContact

POST/policy/{tenantLocator}/accounts/{accountLocator}/contacts

Parameters

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

Request:ContactRoles

Response:AccountResponse

Security Group:accounts

Permission:

write

Delete contact

Delete contactdeleteAccountContact

DELETE/policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Response:AccountResponse

Security Group:accounts

Permission:

write

Update contact

Update contactupdateAccountContact

PATCH/policy/{tenantLocator}/accounts/{accountLocator}/contacts/{contactLocator}

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`contactLocator`	path	`ulid`	Yes

Request:ContactAssociationUpdateRequest

Response:AccountResponse

Security Group:accounts

Permission:

write

ContactAssociationUpdateRequest

Required properties

Property	Type	Description
`addRoles`	`string[]`
`removeRoles`	`string[]`

Fetch contacts

Fetch contactsfetchAccountContacts

GET/policy/{tenantLocator}/accounts/{accountLocator}/contacts

Parameters

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

Response:ContactRoles[]

Security Group:accounts

Permission:

write

Quotes and Policies

Fetch Policies for an Account

Fetch Policies for an AccountfetchPoliciesForAccount

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

Parameters

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

Response:PolicyListResponse

Security Group:accounts

Permissions:

read,list

PolicyResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`issuedTransactionLocator`	`ulid`	The locator of the latest issued transaction for the policy.
`latestSegmentLocator`	`ulid`	The last segment on the policy, based on issued transactions only
`latestTermLocator`	`ulid`
`productName`	`string`
`startTime`	`datetime`	The start time, based on issued transactions only
`endTime`	`datetime`	The end time based on issued transactions only.
`currency`	`string`
`durationBasis`	`Enum years \| months \| weeks \| days \| hours`
`timezone`	`string`
`billingLevel`	`Enum account \| inherit \| policy`
`static`	`map<string, object>`
`createdAt`	`datetime`
`createdBy`	`uuid`
`contacts`	`ContactRoles[]`
`moratoriumElections`	`map<string, string>`
`statuses`	`Enum[] pending \| expired \| cancelled \| cancelPending \| onRisk \| delinquent \| doNotRenew`

Optional properties

Property	Type	Description
`region`	`string?`
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`anonymizedAt`	`datetime?`
`coverageEndTime`	`datetime?`
`invoiceFeeAmount`	`number?`
`jurisdiction`	`string?`
`policyNumber`	`string?`
`producerCode`	`string?`
`producerCodeOfRecord`	`string?`
`validationResult`	`ValidationResult?`
`branchHeadTransactionLocators`	`ulid[]?`	The locators of all the top-level transactions on the policy, one per branch

Fetch Quotes for an Account

Fetch Quotes for an AccountfetchQuotesForAccount

GET/policy/{tenantLocator}/accounts/{locator}/quotes/list

Parameters

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

Response:QuoteListResponse

Security Group:accounts

Permissions:

read,list

QuoteResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`productName`	`string`
`quoteState`	`Enum draft \| validated \| earlyUnderwritten \| priced \| underwritten \| accepted \| issued \| underwrittenBlocked \| declined \| rejected \| refused \| discarded`
`billingLevel`	`Enum account \| inherit \| policy`
`element`	`ElementResponse`	The root element in the hierarchy
`contacts`	`ContactRoles[]`

Optional properties

Property	Type	Description
`policyLocator`	`ulid?`
`groupLocator`	`ulid?`
`quickQuoteLocator`	`ulid?`
`region`	`string?`
`autoRenewalPlanName`	`string?`
`delinquencyPlanName`	`string?`
`issuedTime`	`datetime?`
`startTime`	`datetime?`
`endTime`	`datetime?`
`acceptedTime`	`datetime?`
`currency`	`string?`
`duration`	`number?`	The duration of the prospective policy in units of durationBasis
`durationBasis`	`Enum? years \| months \| weeks \| days \| hours`
`timezone`	`string?`
`anonymizedAt`	`datetime?`
`expirationTime`	`datetime?`
`invoiceFeeAmount`	`number?`
`jurisdiction`	`string?`
`policyNumber`	`string?`
`preferences`	`PreferencesResponse?`	Plan selections and setting overrides
`producerCode`	`string?`
`quoteNumber`	`string?`
`reservedPolicyNumber`	`string?`
`underwritingStatus`	`string?`
`validationResult`	`ValidationResult?`
`static`	`map<string, object>?`
`createdAt`	`datetime?`
`createdBy`	`uuid?`

Fetch Policy Snapshots For An Account

Fetch Policy Snapshots For An AccountfetchPolicySnapshotsForAnAccount

GET/policy/{tenantLocator}/accounts/{locator}/policies/snapshot/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.

Response:PolicySnapshotListResponse

Security Group:accounts

Permissions:

read,list

PolicySnapshotResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`region`	`string`
`productName`	`string`
`currency`	`string`
`timezone`	`string`
`transaction`	`TransactionSnapshotResponse`
`static`	`map<string, object>`

Optional properties

Property	Type	Description
`delinquencyPlanName`	`string?`

Holds

Fetch All Holds For An Account

Fetch All Holds For An AccountfetchAllHoldsForAnAccount

GET/billing/{tenantLocator}/holds/accounts/{accountLocator}/list

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`accountLocator`	path	`ulid`	Yes
`state`	query	`Enum? draft \| validated \| active \| discarded \| released`	No
`offset`	query	`integer?`	No
`count`	query	`integer?`	No
`extended`	query	`boolean?`	No

Response:HoldListResponse

Security Group:holds

Permissions:

read,list

HoldResponse

Required properties

Property	Type	Description
`locator`	`ulid`
`accountLocator`	`ulid`
`holdState`	`Enum draft \| validated \| active \| discarded \| released`
`targetType`	`Enum invoicing \| delinquency`
`updatedAt`	`datetime`
`createdAt`	`datetime`

Optional properties

Property	Type	Description
`validationResult`	`ValidationResult?`

Billing

Update Billing Level For An Account

Update Billing Level For An AccountupdateBillingLevelForAnAccount

PATCH/policy/{tenantLocator}/accounts/{locator}/billingLevel

Parameters

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

Request:UpdateBillingLevelRequest

Response:AccountResponse

Security Group:accounts

Permission:

write

UpdateBillingLevelRequest

Required properties

Property	Type	Description
`billingLevel`	`Enum account \| inherit \| policy`

Numbering

Fetch Accounts With Number

Fetch Accounts With NumberfetchAccountsWithNumber

GET/policy/{tenantLocator}/accounts/numbers/{accountNumber}

Parameters

Name	In	Type	Required	Description
`tenantLocator`	path	`uuid`	Yes
`accountNumber`	path	`string`	Yes

Response:AccountResponse[]

Security Group:accounts

Permissions:

read,list

Set Account Number

Set Account NumbersetAccountNumber

POST/policy/{tenantLocator}/accounts/{locator}/number/set

Parameters

Name	In	Type	Required
`tenantLocator`	path	`uuid`	Yes
`locator`	path	`ulid`	Yes
`accountNumber`	query	`string`	Yes

Response:AccountResponse

Security Group:accounts

Permission:

write

Generate Account Number

Generate Account NumbergenerateAccountNumber

POST/policy/{tenantLocator}/accounts/{locator}/number/generate

Parameters

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

Response:AccountResponse

Security Group:accounts

Permission:

write

Accounts API

On this page