Jump to Content
Website
We're hiring
Courses & Certifications
→ Get started for free
Home
Guides
API Reference
Changelog
Website
We're hiring
Courses & Certifications
→ Get started for free
Log In
API Reference
Log In
Home
Guides
API Reference
Changelog
Dates and timezones
All
Pages
Start typing to search…
JUMP TO
Introduction
Getting started
Idempotency
Errors
Webhooks
Events
Date conversion and timezones
Quotes
Quote package
Endpoints
Create a quote
post
Policyholders
Policyholder
Create
Create a policyholder
post
Upsert a policyholder
put
Retrieve
List all policyholders
get
Retrieve a policyholder
get
List policyholder's applications
get
List policyholder's policies
get
Manage
Update a policyholder
patch
Payment methods
List policyholder payment methods
get
Create payment method
post
Attachments & notes
List attachments
get
Create an attachment
post
List notes
get
Add a note
post
Applications
Application
Create
Create an application
post
Retrieve
List all applications
get
Retrieve an application
get
Retrieve an application alteration package
get
Retrieve application alteration hooks
get
Retrieve application events
get
Manage
Requote an application
put
Send application PDF to policyholder
post
Apply application alteration package
post
Create an application alteration package
post
Archive an application
post
Beneficiaries
List beneficiaries
get
Update beneficiaries
put
Attachments & notes
Retrieve application attachments
get
Add application attachment
post
Retrieve application notes
get
Add application notes
post
Billing & payments
Retrieve application payment method
get
Assign application payment method
post
Archive an attachment
post
Policies
Policy
Create
Issue a policy
post
Issue an aggregated policy
post
Create a policy receipt
post
Retrieve
List all policies
get
Retrieve a policy
get
List policy claims
get
Manage
Update a policy
patch
Bulk cancel policies
post
Bulk reassign policy user groups
put
Bulk lapse policies
post
Create an alteration package
post
Apply alteration package
post
Cancel a policy
post
Prevent or Resume Policy Lapse and NTU
post
Reactivate policy
post
Activate policy
post
Trigger policy scheduled function
post
Update a policy (sandbox only)
patch
Requote policy
post
Beneficiaries
List beneficiaries
get
Update beneficiaries
put
Attachments & notes
List policy attachments
get
Create an attachment
post
Archive an attachment
post
List policy notes
get
Add a note
post
Billing & payments
Update billing amount
post
Get valid collection dates for policy
get
Retrieve a policy's DebiCheck Mandate
get
List policy ledger
get
Retrieve policy payment method
get
Assign a payment method
put
List policy payments
get
Create policy payment
post
Allocate an EFT payment to a policy
post
Create collection request for policy
post
Payment coupons
Cancel payment coupons for a policy
del
Retrieve payment coupons for a policy
get
Create payment coupons for a policy
post
Redeem payment coupon for a policy
post
Cancel a payment coupon for a policy
del
Payment Methods
Endpoints
Update Payment Method Verification Status
patch
List payment methods
get
Dismiss a payment method
post
Manually verify a payment method
post
Billing & payments
Get DebiCheck Mandate
get
Update DebiCheck Mandate
patch
Create DebiCheck Mandate
post
External
List external payment method types
get
Payments
Payment update
Endpoints
Update a payment batch
patch
Create payments async
post
Update payments async
post
Update payment
put
Claims
Claim
Create
Create a claim
post
Retrieve
List all claims
get
Retrieve a claim
get
Manage
Update a claim
patch
Link a policy
post
Send claim to review
post
Close claim
post
Reopen claim
post
Blocks
Update multiple block states
patch
Retrieve a block state
get
Update a block state
patch
Assessor decision
Approve claim
post
Goodwill claim
post
No claim
post
Repudiate claim
post
Supervisor decision
Approval acknowledge
post
Goodwill acknowledge
post
No claim acknowledge
post
Repudiated acknowledge
post
Do not acknowledge approval
post
Do not acknowledge goodwill
post
Do not acknowledge no claim
post
Do not acknowledge claim repudiated
post
Payout requests
Update a payout request
patch
Fulfillment requests
Approve a fulfillment request
patch
Reject a fulfillment request
patch
Attachments & notes
List claim attachments
get
Create an attachment
post
Archive an attachment
post
List claim notes
get
Add a note
post
Retrieve
List claim events
get
Manage
Update claimant
patch
Mark claim as paid out
post
Send claim to capture
post
Calls
Call
Endpoints
List all calls
get
Create a call
post
Retrieve a call
get
Events
Retrieve call events
get
Playback
Retrieve call playback URL
get
Complaints
Complaint
Create
Create a complaint
post
Retrieve
List all complaints
get
Retrieve a complaint
get
Manage
Update a complaint
patch
Close a complaint
post
Update the complainant
patch
Link a policy
post
Reopen a complaint
post
Attachments & notes
List complaint attachments
get
Create an attachment
post
Archive an attachment
post
List complaint notes
get
Add a note
post
List complaint events
get
Notifications
Notification
Endpoints
Trigger a custom notification event
post
List all notifications
get
Create an external notification
post
Retrieve a notification
get
Update an external notification
patch
Leads
Lead
Endpoints
List all leads
get
Create a lead
post
Create or update a lead
put
Archive leads
post
Data stores
Data store
Stores
List all data stores
get
Create a data store
post
Archive a data store
del
Update a data store
patch
Retrieve a data store
get
Entities
Count data store entities
head
List data store entities
get
Create a data store entity
post
Archive a data store entity
del
Retrieve a data store entity
get
Update a data store entity
patch
Data exports
Scheduled data export
Data export runs
List data export runs
get
Retrieve a run
get
Retrieve a run log
get
Scheduled data exports
List all scheduled data exports
get
Create a scheduled data export
post
Retrieve a scheduled data export
get
Update a scheduled data export
patch
Archive a scheduled data export
post
Pause a scheduled data export
post
Resume a scheduled data export
post
Trigger an adhoc run
post
Webhooks
Webhook
Create
Create a webhook
post
Retrieve
List all webhooks
get
Count all webhooks
head
Retrieve a webhook
get
Manage
Update a webhook
patch
Archive a webhook
del
Disable a webhook
post
Enable a webhook
post
Ping a webhook
get
Queue events & attempts
List webhook queue events
get
Count webhook queue events
head
Bulk retry webhook queue events
post
Retry a webhook queue event
post
List webhook queue event attempts
get
Embed
Create
Create an embed URL
post
Sessions
Lookup an Embed session
post
Files
Endpoints
Download file
get
Powered by
Dates and timezones
Ask AI
