How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Root Insurance Policies API

The Policies API from Root Insurance — 32 operation(s) for policies.

Root Insurance Policies API is one of 19 APIs that Root Insurance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Policies. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 41 operations across 32 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.1.

Requests are made against 4 base URLs: https://sandbox.uk.rootplatform.com/v1/insurance, https://api.uk.rootplatform.com/v1/insurance, https://sandbox.rootplatform.com/v1/insurance, https://api.rootplatform.com/v1/insurance.

41 operations 32 paths 34 schemas 2 DELETE12 GET2 PATCH22 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.1
Base URL
https://api.rootplatform.com/
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

Root Insurance Policies API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

Paths & Operations 41

Across 32 paths, the API surfaces 41 operations — 2 DELETE, 12 GET, 2 PATCH, 22 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Policies 41
POST
/policies
Issue a policy
issue-a-policy 1 param body → 200
GET
/policies
List all policies
fetch-policies 9 params → 200
POST
/policies/issue-aggregated
Issue an aggregated policy
issue-aggregated-policy 2 params body → 200
POST
/policies/cancel
Bulk cancel policies
bulk-cancel-policies body → 200
PUT
/user-groups/{user_group_id}/policies
Bulk reassign policy user groups
bulk-reassign-policy-user-groups 1 param body → 200
POST
/policies/lapse
Bulk lapse policies
bulk-lapse-policies body → 200
GET
/policies/{policy_id}
Retrieve a policy
retrieve-policy 1 param → 200
PATCH
/policies/{policy_id}
Update a policy
update-policy 1 param body → 200
POST
/policies/{policy_id}/alteration-packages
Create an alteration package
create-alteration-package 1 param body → 200
POST
/policies/{policy_id}/alteration-packages/{alteration_package_id}/apply
Apply alteration package
apply-alteration-package 2 params → 200
GET
/policies/{policy_id}/attachments
List policy attachments
retrieve-policy-attachments 3 params → 200
POST
/policies/{policy_id}/attachments
Create an attachment
policy-create-attachment 1 param body → 200
POST
/policies/{policy_id}/attachments/{attachment_id}/archive
Archive an attachment
policy-archive-attachment 2 params → 200
GET
/policies/{policy_id}/beneficiaries
List beneficiaries
fetch-policy-beneficiaries 3 params → 200
PUT
/policies/{policy_id}/beneficiaries
Update beneficiaries
update-policy-beneficiaries 1 param body → 200
POST
/policies/{policy_id}/billing
Update billing amount
update-billing-amount 1 param body → 200
POST
/policies/{policy_id}/cancel
Cancel a policy
cancel-policy 1 param body → 200
GET
/policies/{policy_id}/claims
List policy claims
fetch-policy-claims 5 params → 200
GET
/policies/{policy_id}/collection-requests/payment-dates
Get valid collection dates for policy
get-valid-collection-dates-for-policy 3 params → 200
GET
/policies/{policy_id}/debicheck-mandate
Retrieve a policy's DebiCheck Mandate
policy-debicheck-mandate 1 param → 200
POST
/policies/{policy_id}/prevent-lapse-and-ntu
Prevent or Resume Policy Lapse and NTU
prevent-policy-lapse-and-NTU 1 param body
GET
/policies/{policy_id}/ledger
List policy ledger
retrieve-policy-ledger 4 params → 200
GET
/policies/{policy_id}/notes
List policy notes
retrieve-policy-notes 3 params → 200
POST
/policies/{policy_id}/notes
Add a note
policy-add-note 1 param body → 200
DELETE
/policies/{policy_id}/payment-coupons
Cancel payment coupons for a policy
cancel-payment-coupons 1 param → 200
GET
/policies/{policy_id}/payment-coupons
Retrieve payment coupons for a policy
retrieve-payment-coupons 3 params → 200
POST
/policies/{policy_id}/payment-coupons
Create payment coupons for a policy
create-payment-coupons 1 param body → 200
POST
/policies/{policy_id}/payment-coupons/{payment_coupon_id}/redeem
Redeem payment coupon for a policy
redeem-payment-coupons 2 params body → 200
DELETE
/policies/{policy_id}/payment-coupons/{payment_coupon_id}
Cancel a payment coupon for a policy
cancel-payment-coupon 2 params → 200
GET
/policies/{policy_id}/payment-method
Retrieve policy payment method
retrieve-policy-payment-method 1 param → 200
PUT
/policies/{policy_id}/payment-method
Assign a payment method
assign-policy-payment-method 1 param body → 200
GET
/policies/{policy_id}/payments
List policy payments
fetch-policy-payments 6 params → 200
POST
/policies/{policy_id}/payments
Create policy payment
create-policy-payment 2 params body → 200
POST
/policies/{policy_id}/payments/allocate-eft
Allocate an EFT payment to a policy
policy-allocate-eft-payment 1 param body → 200
POST
/policies/{policy_id}/payments/request-collection
Create collection request for policy
policy-collection-request 1 param body → 200
POST
/policies/{policy_id}/reactivate
Reactivate policy
reactivate-policy 1 param body → 200
POST
/policies/{policy_id}/activate
Activate policy
activate-policy 1 param → 200
POST
/policies/{policy_id}/receipts
Create a policy receipt
creating-policy-receipt 1 param body → 200
POST
/policies/{policy_id}/scheduled-functions/{function_name}/trigger
Trigger policy scheduled function
trigger-policy-scheduled-function 2 params → 200
PATCH
/sandbox-only/policies/{policy_id}
Update a policy (sandbox only)
sandbox-only-update-policy 1 param body → 200403
POST
/policies/{policy_id}/requotedeprecated
Requote policy
requote-policy 1 param body → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are policy (41 properties), payment (30 properties), claim (27 properties), payment-response (26 properties). Each schema is shown below with its type and property counts.

premium-type
string
The type of the payment being created.Required when paymenttype is premium or reversal, optional when paymenttype is premiumrefund, forbidden otherwise.
policyholder
object
26 properties 9 required
quote-package
object
Quote packages are designed to be low-fidelity and fast to generate, and are used to generate and display new quotes rapidly on a customer-facing front-end. Th…
12 properties 10 required
attachment
object
7 properties 6 required
actor-type
string
The actor who created the record.
policies
array
alteration-package
object
5 properties 5 required
payment-response
object
26 properties
beneficiary-relationship
string
The beneficiary's relationship to the policyholder.
policyholder-request
object
20 properties 5 required
policy-status
string
The policy status. See the [managing policies](https://docs.rootplatform.com/docs/policy-administrationpolicy-lifecycle) guide for more details on the policy l…
attachments
array
notes
array
failure-action
string
The additional action to perform when processing a failed payment. blockpaymentmethod: Set the payment method's verification status to blocked, and do not gene…
policy
object
Policies are issued from applications, and represent binding insurance agreements. Parameters stored on the policy can be referenced in custom notifications, p…
41 properties 28 required
cellphone
objectnull
null and "" allowed. Object containing the cellphone number in national format, and the corresponding alpha 2 country code.
2 properties 2 required
payment-charge-type
string
Variable charges are applied as a proportion of the total payment amount. Fixed charges are applied as an absolute currency value in cents. The balance is the…
beneficiaries-request
array
null is allowed. An array of beneficiaries. If null, the default beneficiary may be the policyholder if enabled in the product module settings. Some modules ma…
payment-type
string
The type of the payment being created.
payment-method
object
18 properties 5 required
collection-type
string
The collection type of the payment being created.
beneficiaries
array
null is allowed. An array of beneficiaries. If null, the default beneficiary may be the policyholder if enabled in the product module settings. Some product mo…
payment-create
object
15 properties 7 required
note
object
2 properties 2 required
claims
array
payment-details
object
Details of the account into which the payout should be made.
2 properties 2 required
bank-name
string
The name of the bank
payment-status
string
The status to which to create the payment.
payment-coupons
array
alteration-packages
array
cellphone-string
stringnull
null and "" allowed. String containing the cellphone number in international format.
payment-coupon
object
12 properties 6 required
payment
object
30 properties 19 required
claim
object
27 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

root-policies-api-openapi.yml Raw ↑

Other APIs Root Insurance publishes across the network.

Root Bind API
Root Insurance Applications API
Root Insurance Calls API
Root Insurance Claims API
Root Insurance Complaints API
Root Insurance Data exports API
Root Insurance Data stores API
Root Insurance Embed API
Root Insurance Files API
Root Insurance Leads API
Root Insurance Notifications API
Root Insurance Payment Methods API
Where this information came from

This is an independent, third-party profile of Root Insurance Policies API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.