# Root Developer Hub Documentation ## Guides - [Build a collection module](https://docs.rootplatform.com/docs/building-a-collection-module.md) - [Collection module UI components](https://docs.rootplatform.com/docs/render-ui-components.md): How to add UI components for collecting and managing payment details. - [Root lifecycle events](https://docs.rootplatform.com/docs/root-lifecycle-events.md) - [Settings](https://docs.rootplatform.com/docs/settings-cm.md) - [Create a new collection module](https://docs.rootplatform.com/docs/create-a-collection-module.md) - [Examples](https://docs.rootplatform.com/docs/examples.md) - [Stripe Card Collections](https://docs.rootplatform.com/docs/stripe-card-collections.md) - [Collection Modules](https://docs.rootplatform.com/docs/collection-modules.md) - [Environments](https://docs.rootplatform.com/docs/collection-module-environments.md) - [Processes and practices](https://docs.rootplatform.com/docs/processes-and-practices.md) - [Link to Product Module](https://docs.rootplatform.com/docs/linking-a-collection-modules-to-a-product-module.md) - [Publish collection module version](https://docs.rootplatform.com/docs/publish-collection-module-version.md) - [File and folder structure](https://docs.rootplatform.com/docs/file-folder-structure.md): Navigate your local collection module folder with confidence - [Workbench](https://docs.rootplatform.com/docs/workbench-cm.md) - [Workbench CLI tool commands](https://docs.rootplatform.com/docs/workbench-cli-commands.md) - [Collection lifecycle](https://docs.rootplatform.com/docs/collection-lifecycle.md) - [Collection notifications](https://docs.rootplatform.com/docs/collection-notifications.md) - [Collection statuses](https://docs.rootplatform.com/docs/collection-status.md) - [Glossary of collection dates](https://docs.rootplatform.com/docs/glossary-of-collection-dates.md): Glossary - [Collections overview](https://docs.rootplatform.com/docs/collections-overview.md): How premium collections work on Root - [Configuration & rules](https://docs.rootplatform.com/docs/configuration-rules.md) - [Create or update payments](https://docs.rootplatform.com/docs/create-or-update-payments.md) - [Custom payments integration](https://docs.rootplatform.com/docs/custom-payments-integration.md) - [Payment instructions](https://docs.rootplatform.com/docs/payment-instructions.md) - [Manual EFT collections](https://docs.rootplatform.com/docs/manual-eft-collections.md) - [Account number validation (CDV)](https://docs.rootplatform.com/docs/account-number-validation-cdv.md): How Root validates bank account details for debit order payment methods - [Account verification (BANV/AVS)](https://docs.rootplatform.com/docs/account-verification-banvavs.md): How Root verifies bank accounts of policyholders - [Collection strategies](https://docs.rootplatform.com/docs/billing-strategies.md) - [Daily collections process](https://docs.rootplatform.com/docs/daily-payment-routine.md) - [TT2 DebiCheck](https://docs.rootplatform.com/docs/debicheck-mandates.md): How TT2 DebiCheck works on Root - [Native debit order collections](https://docs.rootplatform.com/docs/native-debit-orders.md) - [Setting up your Nedbank account](https://docs.rootplatform.com/docs/setting-up-your-nedbank-account.md) - [Success assumed after 5-days](https://docs.rootplatform.com/docs/success-assumed-after-5-days.md) - [Supported banks](https://docs.rootplatform.com/docs/supported-banks.md) - [Coupons](https://docs.rootplatform.com/docs/payment-coupons.md) - [Course overview](https://docs.rootplatform.com/docs/course-overview.md) - [Product Builder Fundamentals Course](https://docs.rootplatform.com/docs/product-builder-fundamentals-course.md): Welcome to the Root Product Builder Fundamentals Course. During this course, you will learn the ins and outs of the Root platform and become a skilled & qualified technical user of Root. - [Part 1: Getting set up with your first product](https://docs.rootplatform.com/docs/part-1-getting-set-up-with-your-first-product.md) - [Part 2: Generating insurance quotes](https://docs.rootplatform.com/docs/part-2-generating-insurance-quotes.md): Learn how to generate a personalised quote over the Root API or Dashboard. - [Part 3: Issuing policies](https://docs.rootplatform.com/docs/part-3-issuing-policies.md): Learn how to bind a quote and a policyholder to create an application. - [Part 4: Amending policies with alteration hooks](https://docs.rootplatform.com/docs/part-4-amending-policies-with-alteration-hooks.md): Learn how to amend policies using alteration hooks on Root. - [Part 5: Lifecycle Hooks and Reactivation](https://docs.rootplatform.com/docs/part-5-lifecycle-hooks-and-reactivation.md): Learn how to manage policy life cycles and policy reactivation. These hooks are pivotal for maintaining policies effectively. - [Part 6: Scheduled Functions and Anniversary Logic](https://docs.rootplatform.com/docs/part-6-scheduled-functions-and-anniversary-logic.md) - [Part 7: Crafting documents and documentation](https://docs.rootplatform.com/docs/part-7-crafting-documents-and-documentation.md) - [Part 8: Building a Claims and Payout Flow](https://docs.rootplatform.com/docs/part-8-building-a-claims-and-payout-flow.md) - [Part 1.1: Product module specifications](https://docs.rootplatform.com/docs/product-module-specifications.md): These settings are the basis of building your product module, and should be configured in the .root-config.json file from Billing Configuration onwards. - [Wrapping up](https://docs.rootplatform.com/docs/wrapping-up.md) - [Customer notifications overview](https://docs.rootplatform.com/docs/communications-overview.md): Configure automated notifications to policyholders - [Custom notification events](https://docs.rootplatform.com/docs/custom-notification-events.md): Send notifications to customers based on events you configure - [Claim notification events](https://docs.rootplatform.com/docs/standard-claim-notification-events.md): Understand the events that trigger claim notifications, and to which recipients they are sent - [Archived snapshots](https://docs.rootplatform.com/docs/archived-snapshots.md): Use data to access historical data that has been archived - [Connect to Data Adapter](https://docs.rootplatform.com/docs/connect-to-data-adapter.md): Get SQL access to your organisation's data - [Data Adapter queries](https://docs.rootplatform.com/docs/data-adapter-queries.md): Use these examples to execute SQL queries using Data Adapter - [Data Adapter](https://docs.rootplatform.com/docs/data-adapter.md): Table of contents - [Tutorial: Use DBeaver to connect to Data Adapter](https://docs.rootplatform.com/docs/tutorial-use-dbeaver-to-connect-to-data-adapter.md): Use a free SQL tool to connect and query your data - [Tutorial: Use PowerBI to connect to Data Adapter](https://docs.rootplatform.com/docs/tutorial-use-powerbi-to-connect-to-data-adapter.md): Use a PowerBI to connect and query your data - [Data exports](https://docs.rootplatform.com/docs/data-exports-overview.md): Understand the data sources available for export - [Data management overview](https://docs.rootplatform.com/docs/data-management-overview.md): Access your organisation's data on Root for reporting and business intelligence - [Data migrations](https://docs.rootplatform.com/docs/data-migrations.md): Seamlessly transferring historical data from one system and loading it into a new system - [Data stores](https://docs.rootplatform.com/docs/data-stores.md): Store and manage datasets on the Root platform. - [Data definitions](https://docs.rootplatform.com/docs/data-definitions.md) - [Insights overview](https://docs.rootplatform.com/docs/insights.md) - [Query reference](https://docs.rootplatform.com/docs/query-reference.md) - [Claims](https://docs.rootplatform.com/docs/claims-workflow-overview.md) - [Complaints](https://docs.rootplatform.com/docs/complaints.md) - [Overview](https://docs.rootplatform.com/docs/overview.md) - [Managing policies](https://docs.rootplatform.com/docs/policy-administration.md) - [Issuing policies](https://docs.rootplatform.com/docs/policy-issuing.md) - [Webhook setup and verification](https://docs.rootplatform.com/docs/webhook-setup-and-verification.md): Learn how to set up a webhook and verify webhook requests - [API docs](https://docs.rootplatform.com/docs/api-docs.md): Product module API docs (OpenAPI) - [Claim assignments](https://docs.rootplatform.com/docs/claim-assignments.md): Assign claims to the right team‑member at each stage of the workflow - [Claims assessor checklist](https://docs.rootplatform.com/docs/claims-assessor-questions.md): Create a checklist for the claims assessor to verify that all claim information has been provided - [Claims blocks overview](https://docs.rootplatform.com/docs/claims-blocks-overview.md): Customise the information that needs to be captured on a claim - [Claims blocks reference](https://docs.rootplatform.com/docs/claims-blocks-reference.md): Customise the information that needs to be captured on a claim - [Disbursement blocks](https://docs.rootplatform.com/docs/disbursement-blocks.md): Enable beneficiary compensation to be initiated from the claims workflow - [Document labels](https://docs.rootplatform.com/docs/document-labels.md): Define a list of labels for supporting documents uploaded to a claim - [Claims workflow](https://docs.rootplatform.com/docs/claims-workflow.md): Table of contents - [Embed configuration](https://docs.rootplatform.com/docs/configuring-embed.md): Configure a self-service workflow that can be embedded in our existing digital customer journey - [Embed implementation](https://docs.rootplatform.com/docs/embed-implementation.md): Add Embed to your existing customer journey - [Embed overview](https://docs.rootplatform.com/docs/embed-overview.md) - [Embed | Sales prefilling](https://docs.rootplatform.com/docs/embed-sales-prefill-values.md): Inject existing data into your sales flow - [Embed](https://docs.rootplatform.com/docs/embed.md) - [Policyholder prefill from quote](https://docs.rootplatform.com/docs/policyholder-from-quote.md): Prefill policyholder fields with data captured in the quote step. - [Actions](https://docs.rootplatform.com/docs/actions.md): Define automated actions triggered by policy lifecycle events or scheduled functions - [Alteration hooks](https://docs.rootplatform.com/docs/alteration-hooks.md): Configure how existing policy information can be changed - [Application hook](https://docs.rootplatform.com/docs/application-hook.md): How to configure the application hook, which allows your product to create applications based on previously generated quotes - [Event hooks overview](https://docs.rootplatform.com/docs/event-hooks-overview.md): Root building blocks for configuring custom product logic - [Event hooks & actions](https://docs.rootplatform.com/docs/event-hooks-actions.md): Table of contents - [Lifecycle hooks](https://docs.rootplatform.com/docs/lifecycle-hooks.md): Automate actions for existing policies triggered by predefined events - [Policy issue hook](https://docs.rootplatform.com/docs/policy-issue-hook.md): How to configure the policy issue hook, which allows your product to issue policies from existing applications - [Policy Module Display Data Hook](https://docs.rootplatform.com/docs/policy-module-display-data-hook.md) - [Product module code](https://docs.rootplatform.com/docs/product-module-code.md): Configure custom product logic in JavaScript - [Quote hook](https://docs.rootplatform.com/docs/quote-hook.md): How to configure the quote hook, which allows your product to generate quotes - [Reactivation hook](https://docs.rootplatform.com/docs/reactivation-hook.md): How to enable and specify custom logic for reactivating policies - [Requote hook](https://docs.rootplatform.com/docs/requote-hook.md): How to implement requote functionality on a product module - [Scheduled functions](https://docs.rootplatform.com/docs/scheduled-functions.md): Automate actions for existing policies triggered on a time-based schedule - [Glossary](https://docs.rootplatform.com/docs/glossary.md) - [Handlebars helper reference](https://docs.rootplatform.com/docs/handlebars-helper-reference.md): Build templates that dynamically reference policy and related data - [Handlebars overview](https://docs.rootplatform.com/docs/handlebars-overview.md): Build templates that dynamically reference policy and related data - [Handlebars](https://docs.rootplatform.com/docs/handlebars.md): Table of contents - [Policy documents](https://docs.rootplatform.com/docs/policy-documents.md): Build dynamic templates for policy schedules, welcome letters and other policy documents - [Coding standards](https://docs.rootplatform.com/docs/coding-standards.md): Best practices for building product modules - [Git workflow](https://docs.rootplatform.com/docs/git-workflow.md): How use Git to coordinate on product module updates - [Processes and practices](https://docs.rootplatform.com/docs/product-module-build-standards.md) - [Product module tests](https://docs.rootplatform.com/docs/product-module-tests.md): Make product module changes with confidence - [Product module updates and deployments](https://docs.rootplatform.com/docs/product-module-updates-and-deployment.md): Understand the processes and practices used to coordinate on product module updates and deployments - [Product module features](https://docs.rootplatform.com/docs/product-modules-features.md): Understand which features you can configure for your product module, and how they relate to standard platform features - [Product modules overview](https://docs.rootplatform.com/docs/product-modules-overview.md): Configure Root for your insurance product - [Schemas](https://docs.rootplatform.com/docs/schemas.md): Table of contents - [Schema component reference](https://docs.rootplatform.com/docs/schema-component-reference.md): Configure the form elements on the Root management dashboard for quote, application and alteration workflows - [Schemas overview](https://docs.rootplatform.com/docs/schemas-overview.md): Configure the form elements on the Root management dashboard for quote, application and alteration workflows - [Billing settings](https://docs.rootplatform.com/docs/billing-settings.md): Set up your product's basic billing rules without touching any code - [General settings](https://docs.rootplatform.com/docs/general-settings.md): Complete your product's basic setup without touching any code - [Settings](https://docs.rootplatform.com/docs/settings.md) - [File and folder structure](https://docs.rootplatform.com/docs/file-and-folder-structure.md): Navigate your local product module folder with confidence - [Workbench](https://docs.rootplatform.com/docs/workbench.md): Table of contents - [Upgrading to Root Node 24](https://docs.rootplatform.com/docs/upgrading-to-root-node-24.md) - [Workbench CLI tool commands](https://docs.rootplatform.com/docs/workbench-commands.md): Use the Workbench CLI tool to make product module changes and push them to Root - [Workbench dashboard](https://docs.rootplatform.com/docs/workbench-dashboard.md): Access important information related to your product modules from the Root management dashboard - [App notifications](https://docs.rootplatform.com/docs/app-notifications.md) - [Add a new benefit](https://docs.rootplatform.com/docs/add-a-new-benefit.md): Use the Workbench CLI tool to add a new benefit to a product, making changes to different Root features - [Dinosure tutorial](https://docs.rootplatform.com/docs/dinosure-tutorial.md): Get your hands dirty with Root - [Update pricing](https://docs.rootplatform.com/docs/update-pricing.md): Learn how to quickly update a product's pricing, and use Postman for API testing - [Update policy schedule wording](https://docs.rootplatform.com/docs/workbench-basics.md): Use the Workbench CLI tool to make a simple product module update - [Prerequisite skills](https://docs.rootplatform.com/docs/prerequisite-skills.md): Understand the skills required to build insurance products on Root - [Setup tutorial](https://docs.rootplatform.com/docs/setup-tutorial-1.md): Set up the Workbench CLI tool to start building the future of insurance. - [Set up on Root](https://docs.rootplatform.com/docs/set-up-on-root.md): The first step in Getting Started with Root - [Set up Workbench on your local environment](https://docs.rootplatform.com/docs/workbench-setup-local.md): Get the Workbench CLI tool set up on your local machine. This is recommended for production development. - [Team collaboration workflow](https://docs.rootplatform.com/docs/team-collaboration-workflow.md): Use GitHub to collaborate on a product module with other team members - [Getting started with Workbench](https://docs.rootplatform.com/docs/workbench-setup.md): The developer portal into your insurance products. ## API Reference - [Apply application alteration package](https://docs.rootplatform.com/reference/apply-application-alteration-package.md) - [Create an application alteration package](https://docs.rootplatform.com/reference/create-application-alteration-package.md) - [Application](https://docs.rootplatform.com/reference/application.md) - [Add application attachment](https://docs.rootplatform.com/reference/add-application-attachments.md) - [Add application notes](https://docs.rootplatform.com/reference/add-application-notes.md) - [Retrieve application attachments](https://docs.rootplatform.com/reference/retrieve-application-attachments.md) - [Retrieve application notes](https://docs.rootplatform.com/reference/retrieve-application-notes.md) - [List beneficiaries](https://docs.rootplatform.com/reference/fetch-application-beneficiaries.md) - [Update beneficiaries](https://docs.rootplatform.com/reference/update-application-beneficiaries.md): This endpoint accepts an array of beneficiary objects as the body. The entire array of beneficiaries will be replaced. The number of beneficiaries cannot exceed the max defined in the [general settings](doc:general-settings). The percentages must add up to 100%. - [Assign application payment method](https://docs.rootplatform.com/reference/assign-application-payment-method.md) - [Retrieve application payment method](https://docs.rootplatform.com/reference/retrieve-application-payment-method.md) - [Create an application](https://docs.rootplatform.com/reference/create-application.md): **Note:** Additional custom fields may be required depending on how the [application hook](https://docs.rootplatform.com/docs/application-hook) is configured for the product module. - [Archive an application](https://docs.rootplatform.com/reference/archive-application.md) - [Requote an application](https://docs.rootplatform.com/reference/requote-application.md): Note that additional fields may be required based on the product module type being used. See [product modules](doc:product-modules-overview) for more details. - [Send application PDF to policyholder](https://docs.rootplatform.com/reference/send-application-pdf-to-policyholder.md) - [List all applications](https://docs.rootplatform.com/reference/fetch-applications.md) - [Retrieve an application](https://docs.rootplatform.com/reference/retrieve-an-application.md) - [Retrieve application alteration hooks](https://docs.rootplatform.com/reference/retrieve-application-alteration-hooks.md) - [Retrieve an application alteration package](https://docs.rootplatform.com/reference/retrieve-application-alteration-package.md) - [Call](https://docs.rootplatform.com/reference/call.md) - [Create a call](https://docs.rootplatform.com/reference/create-call.md) - [List all calls](https://docs.rootplatform.com/reference/fetch-calls.md) - [Retrieve a call](https://docs.rootplatform.com/reference/retrieve-call.md) - [Approve claim](https://docs.rootplatform.com/reference/approve-claim.md) - [Goodwill claim](https://docs.rootplatform.com/reference/goodwill-claim.md) - [No claim](https://docs.rootplatform.com/reference/no-claim.md) - [Repudiate claim](https://docs.rootplatform.com/reference/repudiate-claim.md) - [Add a note](https://docs.rootplatform.com/reference/claim-add-note.md) - [Archive an attachment](https://docs.rootplatform.com/reference/claim-archive-attachment.md) - [Create an attachment](https://docs.rootplatform.com/reference/claim-create-attachment.md) - [List claim attachments](https://docs.rootplatform.com/reference/retrieve-claim-attachments.md) - [List claim notes](https://docs.rootplatform.com/reference/retrieve-claim-notes.md) - [Retrieve a block state](https://docs.rootplatform.com/reference/retrieve-a-block-state.md): **Note:** This endpoint is product module specific and depends on the [claims blocks schema](https://docs.rootplatform.com/docs/claims-blocks-reference) defined for the product module. - [Update multiple block states](https://docs.rootplatform.com/reference/update-multiple-block-states.md): **Note:** This endpoint is product module specific and depends on the [claims blocks schema](https://docs.rootplatform.com/docs/claims-blocks-reference) defined for the product module. - [Update a block state](https://docs.rootplatform.com/reference/updating-a-block-state.md): **Note:** This endpoint is product module specific and depends on the [claims blocks schema](https://docs.rootplatform.com/docs/claims-blocks-reference) defined for the product module. - [Claim](https://docs.rootplatform.com/reference/claim.md) - [Create a claim](https://docs.rootplatform.com/reference/create-claim.md) - [Approve a fulfillment request](https://docs.rootplatform.com/reference/approve-fulfillment-request.md) - [Reject a fulfillment request](https://docs.rootplatform.com/reference/reject-a-fulfillment-request.md) - [Link a policy](https://docs.rootplatform.com/reference/claim-link-policy.md) - [Close claim](https://docs.rootplatform.com/reference/close-claim.md) - [Reopen claim](https://docs.rootplatform.com/reference/reopen-claim.md) - [Send claim to review](https://docs.rootplatform.com/reference/send-to-review.md) - [Update a claim](https://docs.rootplatform.com/reference/updating-a-claim.md) - [Update a payout request](https://docs.rootplatform.com/reference/update-a-payout-request-1.md) - [List all claims](https://docs.rootplatform.com/reference/fetch-claims.md) - [Retrieve a claim](https://docs.rootplatform.com/reference/retrieve-a-claim.md) - [Approval acknowledge](https://docs.rootplatform.com/reference/acknowledge-approved.md) - [Goodwill acknowledge](https://docs.rootplatform.com/reference/acknowledge-goodwill.md) - [No claim acknowledge](https://docs.rootplatform.com/reference/acknowledge-no-claim.md) - [Repudiated acknowledge](https://docs.rootplatform.com/reference/acknowledge-repudiated.md) - [Do not acknowledge approval](https://docs.rootplatform.com/reference/do-not-acknowledge-approved.md) - [Do not acknowledge goodwill](https://docs.rootplatform.com/reference/do-not-acknowledge-goodwill.md) - [Do not acknowledge no claim](https://docs.rootplatform.com/reference/do-not-acknowledge-no-claim.md) - [Do not acknowledge claim repudiated](https://docs.rootplatform.com/reference/do-not-acknowledge-repudiated.md) - [Archive an attachment](https://docs.rootplatform.com/reference/complaint-archive-attachment.md) - [Create an attachment](https://docs.rootplatform.com/reference/complaint-create-attachment.md) - [Add a note](https://docs.rootplatform.com/reference/complaint-create-note.md) - [List complaint notes](https://docs.rootplatform.com/reference/fetch-complaint-notes.md) - [List complaint attachments](https://docs.rootplatform.com/reference/retrieve-complaint-attachments.md) - [Complaint](https://docs.rootplatform.com/reference/complaint.md) - [Create a complaint](https://docs.rootplatform.com/reference/create-a-complaint.md) - [Close a complaint](https://docs.rootplatform.com/reference/close-complaint.md) - [Link a policy](https://docs.rootplatform.com/reference/complaint-link-policy.md) - [Update the complainant](https://docs.rootplatform.com/reference/complaint-update-complainant.md) - [Reopen a complaint](https://docs.rootplatform.com/reference/reopen-complaint.md) - [Update a complaint](https://docs.rootplatform.com/reference/update-complaint.md) - [List all complaints](https://docs.rootplatform.com/reference/list-all-complaints.md) - [Retrieve a complaint](https://docs.rootplatform.com/reference/retrieve-a-complaint.md) - [Retrieve a run log](https://docs.rootplatform.com/reference/fetch-data-export-run-log.md) - [List data export runs](https://docs.rootplatform.com/reference/fetch-data-export-runs.md) - [Retrieve a run](https://docs.rootplatform.com/reference/retrieve-data-export-run.md) - [Scheduled data export](https://docs.rootplatform.com/reference/scheduled-data-export.md) - [Archive a scheduled data export](https://docs.rootplatform.com/reference/archive-scheduled-data-export.md) - [Create a scheduled data export](https://docs.rootplatform.com/reference/create-scheduled-data-export.md): The following adapters are supported for scheduled data exports: - [List all scheduled data exports](https://docs.rootplatform.com/reference/fetch-scheduled-data-exports.md) - [Pause a scheduled data export](https://docs.rootplatform.com/reference/pause-scheduled-data-export.md) - [Resume a scheduled data export](https://docs.rootplatform.com/reference/resume-scheduled-data-export.md) - [Retrieve a scheduled data export](https://docs.rootplatform.com/reference/retrieve-scheduled-data-export.md) - [Trigger an adhoc run](https://docs.rootplatform.com/reference/trigger-scheduled-data-export.md): Action a scheduled data export immediately regardless of the specified time. - [Update a scheduled data export](https://docs.rootplatform.com/reference/update-scheduled-data-export.md): The following adapters are supported for scheduled data exports: - [Data store](https://docs.rootplatform.com/reference/data-store.md) - [Archive a data store entity](https://docs.rootplatform.com/reference/archive-data-store-entity.md) - [Count data store entities](https://docs.rootplatform.com/reference/count-data-store-entities.md) - [Create a data store entity](https://docs.rootplatform.com/reference/create-data-store-entity.md) - [List data store entities](https://docs.rootplatform.com/reference/list-data-store-entities.md) - [Retrieve a data store entity](https://docs.rootplatform.com/reference/retrieve-data-store-entity.md) - [Update a data store entity](https://docs.rootplatform.com/reference/update-data-store-entity.md) - [Archive a data store](https://docs.rootplatform.com/reference/archive-data-store.md) - [Create a data store](https://docs.rootplatform.com/reference/create-data-store.md) - [List all data stores](https://docs.rootplatform.com/reference/list-data-stores.md) - [Update a data store](https://docs.rootplatform.com/reference/update-data-store.md) - [Create an embed URL](https://docs.rootplatform.com/reference/create-embed-url.md): Generates a unique URL to initiate an Embed session, which allows customers to access various workflows within Embed. This URL can be used in either authenticated or unauthenticated flows. The authenticated flow is recommended for scenarios where the customer's identity is known, enabling seamless access to Embed’s Management and Sales workflows. The unauthenticated flow, intended for use in Embed | Sales only, is suited for scenarios where customer identity is not known upfront. See the [Embed implementation guide](https://docs.rootplatform.com/docs/embed-implementation) for detailed steps on integrating Embed into your customer journey. - [Lookup an Embed session](https://docs.rootplatform.com/reference/lookup-embed-session-1.md): This endpoint allows you to retrieve an existing Embed session using identification details and a `product_module_key`. The session is retrieved based on the customer's identification type, number, and associated organization information. This supports use cases where an organization needs to look up session details securely using authentication. - [Download file](https://docs.rootplatform.com/reference/download-file.md): Download a file by its unique file ID. Files are typically attachments that have been uploaded to the system and associated with various entities like policies, claims, applications, etc. Note: A filename can optionally be appended to the URL for readability (e.g., `/apps/{organization_id}/files/download/{file_id}/report.pdf`), but it is not used for file identification. - [Date conversion and timezones](https://docs.rootplatform.com/reference/date-conversion.md) - [Errors](https://docs.rootplatform.com/reference/errors.md) - [Events](https://docs.rootplatform.com/reference/events.md) - [Getting started](https://docs.rootplatform.com/reference/getting-started-1.md) - [Idempotency](https://docs.rootplatform.com/reference/idempotency.md) - [Webhooks](https://docs.rootplatform.com/reference/webhooks.md) - [Archive leads](https://docs.rootplatform.com/reference/archive-leads.md): This archives all leads loaded for the organization. Returns a HTTP `200 OK` response on success. - [Create a lead](https://docs.rootplatform.com/reference/create-lead.md): This endpoint requires a single lead object defined as follows: - [Create or update a lead](https://docs.rootplatform.com/reference/create-or-update-lead.md): This endpoint requires a single lead object defined as follows: - [List all leads](https://docs.rootplatform.com/reference/fetch-leads.md) - [Lead](https://docs.rootplatform.com/reference/lead.md) - [Create an external notification](https://docs.rootplatform.com/reference/create-external-notification.md): Create a notification with provider of `external`. If you use an integration external to Root to send notifications to end customers, you can use this endpoint to record the notification on Root and link it to the relevant entities (such as a policy or claim). - [List all notifications](https://docs.rootplatform.com/reference/fetch-notifications.md) - [Retrieve a notification](https://docs.rootplatform.com/reference/retrieve-a-notification.md) - [Trigger a custom notification event](https://docs.rootplatform.com/reference/trigger-custom-notification-event.md): Queue a custom notification request (or first queue policy documents to be generated if there are email attachments). A `200 (Success)` response does not indicate that the notification was sent successfully. Please refer to the [custom notification events](doc:custom-notification-events) guide. - [Update an external notification](https://docs.rootplatform.com/reference/update-external-notification.md): Update the status of a notification with provider of `external`. - [Notification](https://docs.rootplatform.com/reference/notification.md) - [Create DebiCheck Mandate](https://docs.rootplatform.com/reference/create-debicheck-mandate.md): Creates a new DebiCheck mandate for a policy. - [Get DebiCheck Mandate](https://docs.rootplatform.com/reference/get-debicheck-mandate.md): Retrieves a DebiCheck mandate by ID. - [Update DebiCheck Mandate](https://docs.rootplatform.com/reference/update-debicheck-mandate.md): Updates a DebiCheck mandate by ID. - [Update Payment Method Verification Status](https://docs.rootplatform.com/reference/update-payment-method-verification-status.md): This endpoint validates the input and updates the status of a payment method, which will result in a `200 OK` successful response, with the updated payment method in the response. - [Create payments async](https://docs.rootplatform.com/reference/async-payments-create.md): This endpoint is deprecated in favour of [create payment](ref:createpolicypayment). This endpoint validates the input and queues payments to be processed asynchronously. A response of `200 OK` is sent if the payments are valid and have been successfully queued. This endpoint allows for up to 5000 payments to be created at a time. To use this endpoint you'll need the `Payments Create` permission. - [Update a payment batch](https://docs.rootplatform.com/reference/update-payment-batch.md) - [Update payment](https://docs.rootplatform.com/reference/update-payment.md): This endpoint validates the input and updates a payment, which will result in a `200 OK` successful response, with the updated payment in the response. - [Update payments async](https://docs.rootplatform.com/reference/update-payments-async.md): This endpoint validates the input and queues [payment updates](ref:payment-update) to be processed asynchronously, which will result in a `200 OK` successful response. **Note:** Despite a successful response, queued updates can nevertheless fail. To receive the update failure / success status, subscribe to the `payment_updates_succeeded` and `payment_updates_failed` [webhooks](ref:create-webhook). - [Payment update](https://docs.rootplatform.com/reference/payment-update.md) - [Add a note](https://docs.rootplatform.com/reference/policy-add-note.md) - [Archive an attachment](https://docs.rootplatform.com/reference/policy-archive-attachment-1.md) - [Create an attachment](https://docs.rootplatform.com/reference/policy-create-attachment-1.md) - [List policy attachments](https://docs.rootplatform.com/reference/retrieve-policy-attachments-1.md) - [List policy notes](https://docs.rootplatform.com/reference/retrieve-policy-notes-1.md): List all notes that have been added to a policy. - [List beneficiaries](https://docs.rootplatform.com/reference/fetch-policy-beneficiaries.md) - [Update beneficiaries](https://docs.rootplatform.com/reference/update-policy-beneficiaries.md): This endpoint accepts an array of beneficiary objects as the body. The entire array of beneficiaries will be replaced. The number of beneficiaries cannot exceed the max defined in the [general settings](doc:general-settings). The percentages must add up to 100%. - [Assign a payment method](https://docs.rootplatform.com/reference/assign-policy-payment-method.md): Assign a payment method to a policy. Read more about [payment methods](doc:billing#payment-methods). - [Create policy payment](https://docs.rootplatform.com/reference/create-policy-payment.md): This endpoint validates the input and creates a payment, which will result in a `200 OK` successful response, with the created payment in the response. - [List policy payments](https://docs.rootplatform.com/reference/fetch-policy-payments.md): Retrieve payments linked to a policy. Read more about how payments work on Root in the [payments guides](doc:payments-overview). - [Get valid collection dates for policy](https://docs.rootplatform.com/reference/get-valid-collection-dates-for-policy-1.md): This endpoint is used to retrieve valid payment dates when submitting collection requests. The payment date is the date on which the collection request will strike the policyholder's bank account. The payment date returned to you will then be used as a parameter when [creating a collection request](ref:create-policy-payments-collection-request-1). - [Allocate an EFT payment to a policy](https://docs.rootplatform.com/reference/policy-allocate-eft-payment.md) - [Create collection request for policy](https://docs.rootplatform.com/reference/policy-collection-request.md) - [Retrieve a policy's DebiCheck Mandate](https://docs.rootplatform.com/reference/policy-debicheck-mandate-1.md) - [List policy ledger](https://docs.rootplatform.com/reference/retrieve-policy-ledger-1.md) - [Retrieve policy payment method](https://docs.rootplatform.com/reference/retrieve-policy-payment-method.md) - [Update billing amount](https://docs.rootplatform.com/reference/update-billing-amount-1.md) - [Create a policy receipt](https://docs.rootplatform.com/reference/creating-policy-receipt-1.md): Once a policy has been issued, it is important that a receipt is created which verifies that the new policyholder has received their actual policy. This receipt can either be in the form of a tracking pixel in an email which contains the policy document, or it could be a custom method (subject to approval). To add a tracking pixel to a policy email, you create an `` tag which looks like the following: ```html ``` Important to note is that the tag includes the policy version number and the policy unique identifier in the query string, while the image name that of your `organisation_id`. Alternatively if you wish to use a custom receipt method, you can `POST` to the receipt endpoint. This endpoint accepts any valid JSON object, but MUST include the version number in the body. The body value should be any data which could be reasonably said to be evidence of the policyholder receiving the policy document. - [Issue a policy](https://docs.rootplatform.com/reference/issue-a-policy-1.md) - [Issue an aggregated policy](https://docs.rootplatform.com/reference/issue-aggregated-policy.md) - [Activate policy](https://docs.rootplatform.com/reference/activate-policy.md) - [Apply alteration package](https://docs.rootplatform.com/reference/apply-alteration-package-1.md) - [Bulk cancel policies](https://docs.rootplatform.com/reference/bulk-cancel-policies-1.md): This endpoint creates a set of cancel requests for the specified policies, which will then asynchronously cancel each specified policy. It will return an empty `200 OK` response on success. The endpoint requires an array of policy cancel objects, defined as follows: - [Bulk lapse policies](https://docs.rootplatform.com/reference/bulk-lapse-policies-1.md): This endpoint creates a set of lapse requests for the specified policies, which will then asynchronously lapse each specified policy. It will return an empty `200 OK` response on success. The endpoint requires an array of policy lapse objects, defined as follows: - [Bulk reassign policy user groups](https://docs.rootplatform.com/reference/bulk-reassign-policy-user-groups.md): Assign a list of existing policies to the specified user groups. The operation will attempt to add each policy in the policy_ids array to the user group, and return per-policy results along with an overall status. - [Cancel a policy](https://docs.rootplatform.com/reference/cancel-policy-1.md) - [Create an alteration package](https://docs.rootplatform.com/reference/create-alteration-package.md) - [Prevent or Resume Policy Lapse and NTU](https://docs.rootplatform.com/reference/prevent-policy-lapse-and-ntu.md): This endpoint enables users to specify a period during which the policy is safeguarded from lapsing or entering an NTU state. Alternatively, it can be used to resume the lapse and NTU processes if needed. When preventing lapses, the request requires the start and end dates for the period, along with the reason. For resuming lapses, only the `resume` parameter is required. - [Reactivate policy](https://docs.rootplatform.com/reference/reactivate-policy.md) - [Requote policy](https://docs.rootplatform.com/reference/requote-policy.md): This endpoint is deprecated in favour of [alteration hooks](ref:create-an-alteration-package). - [Update a policy (sandbox only)](https://docs.rootplatform.com/reference/sandbox-only-update-policy.md): Update attributes on a policy, bypassing the product module code validation. **Note:** This endpoint is intended to be used for testing purposes and, as such, is only available in the sandbox environment. - [Trigger policy scheduled function](https://docs.rootplatform.com/reference/trigger-policy-scheduled-function.md): Queues a [scheduled function](doc:scheduled-functions) to be executed asynchronously for a policy. **Note:** Despite a successful response, a queued function execution can nevertheless fail. Check the product module execution logs for the result. - [Update a policy](https://docs.rootplatform.com/reference/update-policy.md) - [Cancel a payment coupon for a policy](https://docs.rootplatform.com/reference/cancel-payment-coupon-1.md) - [Cancel payment coupons for a policy](https://docs.rootplatform.com/reference/cancel-payment-coupons-1.md): Cancel all pending payment coupons for a policy - [Create payment coupons for a policy](https://docs.rootplatform.com/reference/create-payment-coupons-1.md) - [Redeem payment coupon for a policy](https://docs.rootplatform.com/reference/redeem-payment-coupons.md) - [Retrieve payment coupons for a policy](https://docs.rootplatform.com/reference/retrieve-payment-coupons-1.md) - [Policy](https://docs.rootplatform.com/reference/policy.md) - [List all policies](https://docs.rootplatform.com/reference/fetch-policies.md) - [List policy claims](https://docs.rootplatform.com/reference/fetch-policy-claims.md) - [Retrieve a policy](https://docs.rootplatform.com/reference/retrieve-policy.md) - [List notes](https://docs.rootplatform.com/reference/fetch-policyholder-notes.md) - [Add a note](https://docs.rootplatform.com/reference/policyholder-add-note.md) - [Create an attachment](https://docs.rootplatform.com/reference/policyholder-create-attachment-3.md) - [List attachments](https://docs.rootplatform.com/reference/retrieve-policyholder-attachments-3.md) - [Create a policyholder](https://docs.rootplatform.com/reference/create-policyholder.md) - [Upsert a policyholder](https://docs.rootplatform.com/reference/upsert-policyholder.md) - [Update a policyholder](https://docs.rootplatform.com/reference/update-policyholder.md) - [Create payment method](https://docs.rootplatform.com/reference/create-policyholder-payment-method.md): Create a payment method. Read more about [payment methods](doc:billing-settings#payment-method-types). - [List policyholder payment methods](https://docs.rootplatform.com/reference/fetch-policyholder-payment-methods.md) - [Policyholder](https://docs.rootplatform.com/reference/policyholder.md) - [List policyholder's applications](https://docs.rootplatform.com/reference/fetch-policyholders-applications.md) - [List policyholder's policies](https://docs.rootplatform.com/reference/fetch-policyholders-policies.md) - [List all policyholders](https://docs.rootplatform.com/reference/fetch-policyholders.md) - [Retrieve a policyholder](https://docs.rootplatform.com/reference/retrieve-policyholder.md) - [Create a quote](https://docs.rootplatform.com/reference/create-quote.md): Note that additional fields may be required based on the product module type being used. See [product modules](doc:product-modules-overview) for more details. - [Quote package](https://docs.rootplatform.com/reference/quote-package.md) - [Create a secret key](https://docs.rootplatform.com/reference/create-secret-key.md) - [Retrieve all secret keys](https://docs.rootplatform.com/reference/retrieve-secret-keys.md) - [Upsert a secret key](https://docs.rootplatform.com/reference/upsert-secret-key.md) - [Create a webhook](https://docs.rootplatform.com/reference/create-webhook.md) - [Archive a webhook](https://docs.rootplatform.com/reference/archive-webhook.md) - [Disable a webhook](https://docs.rootplatform.com/reference/disable-webhook.md): When a webhook is disabled, queue events it is subscribed to will be marked as `failed` and will not be sent to the webhook's URL. - [Enable a webhook](https://docs.rootplatform.com/reference/enable-webhook.md): When a webhook is enabled, Root will attempt to send queue events to the webhook's URL. - [Ping a webhook](https://docs.rootplatform.com/reference/ping-webhook.md): In order to test that your webhook correctly receives and processes events, you can send a "ping" event on request. This endpoint dispatches a `webhook_ping` event to the specified webhook (see [webhook subscriptions](ref:webhooks#available-subscriptions) for more details). - [Update a webhook](https://docs.rootplatform.com/reference/update-webhook.md) - [Bulk retry webhook queue events](https://docs.rootplatform.com/reference/bulk-retry-webhook-queue-events.md): Retry multiple webhook queue events for a given webhook. The queue events identified by the filters will be added to the queue to be re-attempted with priority 2 (low). - [Count webhook queue events](https://docs.rootplatform.com/reference/count-webhook-queue-events.md) - [List webhook queue event attempts](https://docs.rootplatform.com/reference/list-webhook-queue-event-attempts.md): Get attempts for a webhook queue event - [List webhook queue events](https://docs.rootplatform.com/reference/list-webhook-queue-events.md): Get queue events for a webhook. A queue event represents a single message to be delivered to the webhook URL, and may have multiple attempts. - [Retry a webhook queue event](https://docs.rootplatform.com/reference/retry-webhook-queue-event.md): Add a webhook queue event back to the queue to be re-attempted with priority 2 (low). - [Count all webhooks](https://docs.rootplatform.com/reference/count-webhooks.md) - [List all webhooks](https://docs.rootplatform.com/reference/list-webhooks.md) - [Retrieve a webhook](https://docs.rootplatform.com/reference/retrieve-webhook.md) - [Webhook](https://docs.rootplatform.com/reference/webhook.md) ## Changelog - [Root release notes | January 2026](https://docs.rootplatform.com/changelog/root-release-notes-january-2026.md) - [Root release notes | December 2025](https://docs.rootplatform.com/changelog/root-release-notes-december-2025.md) - [Root release notes | November 2025](https://docs.rootplatform.com/changelog/root-release-notes-november-2025.md) - [Root release notes | October 2025](https://docs.rootplatform.com/changelog/root-release-notes-october-2025.md) - [Root release notes | September 2025](https://docs.rootplatform.com/changelog/root-release-notes-september-2025.md)