API Permissions Reference

Account API

Action	Endpoint	Permission
Authenticate a standard account	POST /account/authenticate	none
Authenticate an admin account	POST /account/authenticateAdmin	none
Renew an authentication token	POST /account/renewAuthentication	none
Unlock an account that has been locked out due to failed login attempts	POST /account/unlock	Administrator
Update a password	PATCH /account/v1/accounts/password	none

Auxiliary Data API

Action	Endpoint	Permission
Set or update an auxiliary data record set	PUT /auxData/{locator}	auxData.write
Retrieve a single auxiliary data record	GET /auxData/{locator}/{key}	auxData.fetch
Fetch a set of auxiliary data record keys	GET /auxData/{locator}	auxData.fetch
Delete an auxiliary data record	DELETE /auxData/{locator}/{key}	auxData.delete

Calculation API

Action	Endpoint	Permission
Test Calculate Peril Premium	POST /calculation/checkPerilPremium	calculation.check
Test Calculate Premium for an Existing Peril	POST /calculation/checkExistingPerilPremium	calculation.check

Cancellations API

Action	Endpoint	Permission
Fetch a grace period	GET /gracePeriod/{gracePeriodLocator}	gracePeriod.fetch
Update a grace period	PATCH /gracePeriod/{gracePeriodLocator}	gracePeriod.update
Create a cancellation	POST /policies/{locator}/cancellations	cancellation.create
Fetch a cancellation	GET /cancellations/{locator}	cancellation.fetch
Update a cancellation	PATCH /cancellations/{locator}	cancellation.update
Issue a cancellation	PATCH /cancellations/{locator}/issue	cancellation.issue
Rescind a cancellation	PATCH /cancellations/{locator}/rescind	cancellation.rescind
Fetch Pricing for a cancellation	GET /cancellations/{locator}/price	cancellation.fetch
Fetch cancellations for a policy	GET /policies/{locator}/cancellations	cancellation.fetch
Fetch grace periods for a policy	GET /policy/{policyLocator}/gracePeriods	gracePeriod.fetch

Cash Management API

Action	Endpoint	Permission
Fetch a cash balance	GET /cashBalances/{cashBalanceLocator}	cashBalance.fetch
Transfer funds between cash balances	PATCH /cashBalances/{sourceCashBalanceLocator}	cashBalance.transfer
Create a disbursement	POST /cashBalances/{cashBalanceLocator}/disbursements	disbursement.create
Update or issue a disbursement	PATCH /disbursements/{disbursementLocator}	disbursement.update
Fetch a disbursement	GET /disbursements/{disbursementLocator}	disbursement.fetch
Fetch disbursements	GET /disbursements	disbursement.fetch
Issue a catch-up	POST /cashBalances/{cashBalanceLocator}/invoices	catchUpInvoice.issue
Write off a catch-up	PATCH /catchUps/{catchupLocator}/writeOff	catchUpInvoice.writeOff
Invalidate a catch-up	PATCH /catchUps/{catchupLocator}/invalidate	catchUpInvoice.invalidate
Fetch a catch-up	GET /catchUps/{catchupLocator}	catchUpInvoice.fetch
Fetch catch-ups	GET /catchUps	catchUpInvoice.fetch
Fetch cash balance records	GET /cashBalanceLog/records	cashBalanceLog.fetch
Fetch attributed cash balance records	GET /cashBalanceLog/attributedRecords	cashBalanceLog.fetch

Claims API

Action	Endpoint	Permission
Update a claim	POST /claim/{claimLocator}/update	claim.update
Fetch a specific claim	GET /claim/{claimLocator}	claim.fetch
Fetch all claims for a policy	GET /policy/{policyLocator}/claims	policy.fetch
Find claims in a date range	GET /claims	claim.fetch
Discard a claim	POST /claim/{claimLocator}/discard	claim.discard
Create a subclaim payable	POST /claims/payables	claim.createPayable
Get a payable	GET /claims/payables/{payableLocator}	claim.fetch
Reverse a payable	POST /claims/payables/reversals	claim.reversePayable
Fetch a subclaim summary	GET /subClaim/{subClaimLocator}/summary	claim.reversePayable
Fetch subclaim payables	GET /subClaim/{subClaimLocator}/payables	claim.fetch
Fetch subclaim reserves	GET /subClaim/{subClaimLocator}/reserves	claim.fetch

Configuration API

Action	Endpoint	Permission
Deploy test configuration WITHOUT Product Versioning	POST /configuration/deployTest	Administrator
Repair test configuration WITH Product Versioning	POST /configuration/studio/repair	Administrator
Deploy production configuration WITH Product Versioning	POST /configuration/deploy	Administrator
Deploy production configuration WITHOUT Product Versioning	POST /assets/v1/deploy	Administrator
Repair production configuration WITH Product Versioning	POST /configuration/repair	Administrator

Data Auto-fill API

Action	Endpoint	Permission
Add an autofill operation	PUT /integrations/autofill	Administrator
Fetch autofill operations	GET /integrations/autofill	Administrator
Fetch an individual operation	GET /integrations/autofill/{locator}	Administrator
Remove an operation	DELETE /integrations/autofill/{locator}	Administrator

Deployments API

Action	Endpoint	Permission
Fetch versions in use	GET /deployments/versions	deployment.fetch
Fetch configuration zip file	GET /deployments/{configVersion}	deployment.fetch
Get status of a deployment	GET /deployments/status	deployment.fetch

Document API

Action	Endpoint	Permission
Render a document for an existing policy, given a liquid template	POST /document/renderPolicyDocument	document.write
Render a document for an existing policy, given a liquid template filename	POST /document/renderPolicyDocumentFromConfig	document.write

Endorsements API

Action	Endpoint	Permission
Create an endorsement	POST /policies/{policyLocator}/endorsements	endorsement.create
List all endorsements for a policy	GET /policies/{policyLocator}/endorsements	endorsement.fetch
Fetch an endorsement	GET /endorsements/{endorsementLocator}	endorsement.fetch
Fetch the underwriting decision for an endorsement	GET /endorsements/{endorsementLocator} /automatedUnderwritingResult	endorsement.fetch
Fetch the pricing change for an endorsement	GET /endorsements/{endorsementLocator}/price	endorsement.fetch
Update an endorsement	PATCH /endorsements/{endorsementLocator}/update	endorsement.update
Quote an endorsement	PATCH /endorsements/{endorsementLocator}/quote	endorsement.quote
Accept an endorsement	PATCH /endorsements/{endorsementLocator}/accept	endorsement.accept
Invalidate an endorsement	PATCH /endorsements/{endorsementLocator}/invalidate	endorsement.invalidate
Discard an endorsement	PATCH /endorsements/{endorsementLocator}/discard	endorsement.discard
Issue an endorsement	PATCH /endorsements/{endorsementLocator}/issue	endorsement.issue
Get policy as if the endorsement were issued	GET /endorsements/{endorsementLocator}/policyWhenIssued	endorsement.fetch
Update, accept or issue an endorsement	PATCH /endorsements/{endorsementLocator}	endorsement.*

Event Stream API

Action	Endpoint	Permission
Fetch events	GET /eventstream/events	eventstream.fetch
Fetch attributed events	GET /eventstream/attributedEvents	eventstream.fetch

Integrations API

Action	Endpoint	Permission
Add an external service integration	POST /integrations	Administrator
Update an existing external service integration	PUT /integrations/{integrationName}	Administrator
Remove an existing external service integration	DELETE /integrations/{integrationName}	Administrator

Invoice API

Action	Endpoint	Permission
Fetch an invoice	GET /invoice/{invoiceLocator}	invoice.fetch
Pay an invoice	POST /invoice/{invoiceLocator}/pay	invoice.pay
Write-off an invoice	PATCH /invoice/{invoiceLocator}/writeOff	invoice.writeOff
Fetch financial transactions for an invoice	GET /invoice/{invoiceLocator}/financialTransactions	invoice.fetch

Lambda API

Action	Endpoint	Permission
Call the Lambda service and execute the plugin	POST /lambda	lambda.write

Media API

Action	Endpoint	Permission
Upload a media item	POST /media	media.upload
Fetch a media item	GET /media/{locator}	media.fetch

Payments API

Action	Endpoint	Permission
Fetch a payment	GET /payments/{paymentLocator}	payment.fetch
Reverse a payment	POST /payments/{paymentLocator}/reverse	payment.reverse
Create a payment	POST /payments	payment.create
Update a payment	PATCH /payments/{paymentLocator}	payment.update
Fetch payments	GET /payments	payment.fetch

Policy API

Action	Endpoint	Permission
Create a policy	POST /policy	policy.create
Fetch a policy	GET /policy/{policyLocator}	policy.fetch
Update a draft policy	POST /policy/{policyLocator}/update	policy.update
Finalize a policy	POST /policy/{policyLocator}/finalize	policy.quote
Issue a policy	POST /policy/{policyLocator}/issue	policy.issue
Discard a policy	POST /policy/{policyLocator}/discard	policy.discard
Add a document to a policy	POST /policy/{policyLocator}/addDocument	policy.addDocument
Remove a document from a policy	POST /policy/{policyLocator}/removeDocument	policy.removeDocument
Fetch a policy’s automated underwriting result	GET /policy/{policyLocator}/automatedUnderwritingResult	policy.fetch
Add or reverse fees	PATCH /policy/{policyLocator}/fees	policy.fee
Fetch a policy’s pricing data	GET /policy/{policyLocator}/price	policy.fetch
Price a policy	POST /policy/{policyLocator}/price	policy.quote
Change Payment Schedule	POST /policy/{policyLocator}/paymentSchedule	policy.paymentSchedule
Fetch a policy’s invoices	GET /policy/{policyLocator}/checkInvoices	policy.fetch
Issue the next invoice for a policy	POST /policy/{policyLocator}/issueNextInvoice	policy.issue
Fetch a Policy Snapshot	POST /policies/{policyLocator}/snapshot	policy.fetch
Fetch a Policy Coverage Summary	POST /policies/{policyLocator}/coverageSummary	policy.fetch
Upgrade a policy’s product version	PATCH /policy/{policyLocator}/upgrade	policy.update
Cancel a policy	POST /policy/{policyLocator}/cancel	policy.discard
Fetch a policy’s cancellation value	GET /policy/{policyLocator}/cancellationValue	policy.fetch
Withdraw a policy	POST /policy/{policyLocator}/withdraw	policy.discard

Policyholder API

Action	Endpoint	Permission
Create a policyholder	POST /policyholder/create	policyholder.create
Update a policyholder	POST /policyholder/update	policyholder.update
Fetch policyholders	GET /policyholders	policyholder.fetch
Fetch a policyholder	GET /policyholder/{policyholderLocator}	policyholder.fetch
Fetch policies for policyholder	GET /policyholder/{policyholderLocator}/policies	policyholder.fetch and policy.fetch
Fetch invoices for policyholder	GET /policyholder/{policyholderLocator}/invoices	policyholder.fetch and invoice.fetch
Overwrite policyholder data	PATCH /policyholder/{policyholderLocator}/overwriteData	policyholder.overwrite

Premium Reporting API

Action	Endpoint	Permission
Create a premium report	POST /policies/{policyLocator}/premiumReports	premiumReport.create
Fetch a premium report	GET /premiumReports/{premiumReportLocator}	premiumReport.fetch
Fetch all premium reports for a policy	GET /policies/{policyLocator}/premiumReports	premiumReport.fetch
Update a draft premium report	PATCH /premiumReports/{premiumReportLocator}	premiumReport.update
Issue a premium report	PATCH /premiumReports/{premiumReportLocator}/issue	premiumReport.issue
Discard a premium report	PATCH /premiumReports/{premiumReportLocator}/discard	premiumReport.discard
Reverse a premium report	PATCH /premiumReports/{premiumReportLocator}/reverse	premiumReport.reverse
Replace a premium report	POST /premiumReports/{premiumReportLocator}/replace	premiumReport.replace

Products API

Action	Endpoint	Permission
Fetch all product configurations in a tenant	GET /products/	product.fetch
Fetch all product configurations in a tenant	GET /products/{configVersion}	product.fetch
Fetch configuration information for policyholders	GET /products/policyholder	product.fetch

Quotes API

Action	Endpoint	Permission
Fetch all quotes for a policy	GET /policies/{policyLocator}/quotes	quote.fetch
Fetch a quote	GET /quotes/{quoteLocator}	quote.fetch
Update a draft quote	PATCH /quotes/{quoteLocator}	quote.update
Create a new quote using an existing quote	POST /quotes/{quoteLocator}/createNew	quote.create
Select a quote	PATCH /quotes/{quoteLocator}/select	quote.quote
Price a quote and lock in details	PATCH /quotes/{quoteLocator}/quote	quote.quote
Fetch pricing for a quote that has already been quoted	GET /quotes/{quoteLocator}/price	quote.fetch
Accept a quote	PATCH /quotes/{quoteLocator}/accept	quote.accept
Invalidate a previously accepted quote	PATCH /quotes/{quoteLocator}/invalidate	quote.invalidate
Discard a quote	PATCH /quotes/{quoteLocator}/discard	quote.discard

Reinstatements API

Action	Endpoint	Permission
Create a reinstatement	PATCH /cancellations/{cancellationLocator}/reinstate	reinstatement.create
Fetch a reinstatement	GET /reinstatements/{locator}	reinstatement.fetch
Update a reinstatement	PATCH /reinstatements/{locator}	reinstatement.update
Accept a reinstatement	PATCH /reinstatements/{locator}/accept	reinstatement.accept
Issue a reinstatement	PATCH /reinstatements/{locator}/issue	reinstatement.issue
Invalidate a reinstatement	PATCH /reinstatements/{locator}/invalidate	reinstatement.invalidate
Fetch pricing for a reinstatement	GET /reinstatements/{locator}/price	reinstatement.fetch

Renewals API

Action	Endpoint	Permission
Create a renewal	POST /policies/{policyLocator}/renewals	renewal.create
List renewals for a policy	GET /policies/{policyLocator}/renewals	renewal.fetch
Fetch a renewal	GET /renewals/{renewalLocator}	renewal.fetch
Fetch a renewal’s underwriting decision	GET /renewals/{renewalLocator}/automatedUnderwritingResult	renewal.fetch
Fetch a renewal’s pricing changes	GET /renewals/{renewalLocator}/price	renewal.fetch
Update a renewal	PATCH /renewals/{renewalLocator}/update	renewal.update
Quote a renewal	PATCH /renewals/{renewalLocator}/quote	renewal.quote
Accept a renewal	PATCH /renewals/{renewalLocator}/accept	renewal.accept
Invalidate a renewal	PATCH /renewals/{renewalLocator}/invalidate	renewal.invalidate
Discard a renewal	PATCH /renewals/{renewalLocator}/discard	renewal.discard
Issue a renewal	PATCH /renewals/{renewalLocator}/issue	renewal.issue
Get policy as if the renewal were issued	GET /renewals/{renewalLocator}/policyWhenIssued	renewal.fetch
Edit, accept, or issue a renewal	PATCH /renewals/{renewalLocator}	renewal.*

Reporting API

Action	Endpoint	Permission
Fetch report status	GET /report/{reportLocator}/status	report.fetch
Run the On-Risk report	POST /report/onRisk	report.fetch
Run the All Policies report	POST /report/allPolicies	report.fetch
Run the Financial Transactions report	POST /report/financialTransaction	report.fetch
Run the Paid Financial Transactions report	POST /report/paidFinancialTransaction	report.fetch
Run the Unearned Premium Accounts Receivable report	POST /report/unearnedPremium/accountsReceivable	report.fetch
Run the Payable Commissions report	POST /report/payableCommissions	report.fetch
Run the Reserves report	POST /report/claim/reserves	report.fetch
Run the Claims report	POST /report/claim	report.fetch
Run the Claims Payables report	POST /report/claim/payables	report.fetch

Scripts API

Action	Endpoint	Permission
Query scripting logs	POST /scripts/queryLogs	scripts.fetch

Search API

Action	Endpoint	Permission
Make a search request	POST /search	search.fetch
Retrieve search results	GET /search/{searchToken}/{pageNumber}	search.fetch

Tables API

Action	Endpoint	Permission
Get table by locator	GET /tables/{locator}	Administrator
Get tables	GET /tables/	Administrator
Delete table	DELETE /tables/{locator}	Administrator

Webhooks API

Action	Endpoint	Permission
Create or Update a Webhook	PUT /webhooks	Administrator
Get all Webhooks	GET /webhooks	Administrator
Get a Webhook	GET /webhooks/{name}	Administrator
Delete a Webhook	DELETE /webhooks/{name}	Administrator
Enable a suspended Webhook	PATCH /webhooks/{name}/unsuspend	Administrator
Get a paginated list of diverted events	GET /webhooks/{name}/diverted	Administrator
Delete a diverted event	DELETE /webhooks/{name}/diverted/{transactionId}	Administrator
Resend a diverted event	POST /webhooks/{name}/diverted/{transactionId}/resend	Administrator