Policy Module

Search…

Policy Module

get
https://api.tint.ai
/v2/insurance-products
Get Insurance Products
post
https://api.tint.ai
/v2/policy
Create a Policy
post
https://api.tint.ai
/v2/policy/issue
Create an Issued Policy
To further interact with the API, you need to store the policy id returned by Tint.
get
https://api.tint.ai
/v2/policy/:id
Get a Policy
put
https://api.tint.ai
/v2/policy/:id
Update a Policy
For example, you first created the policy to get the quotes for the different plans of your insurance product. Now your customer has subscribed to the policy and paid for it. 
You can add the payment information to the policy. This way, if you score the policy or make a decision whether to accept or reject this policy, all the information available for the policy, including the payment information, is taken into account. Usually, the type of card used for payment (debit, credit) helps building a more robust risk profile and is used by the underlying AI models.
If you have any doubts, feel free to ping us on the best implementation based on your use case on [email protected] or via your dedicated Slack channel.
You can't change the insurance product of an existing policy.
post
https://api.tint.ai
/v2/policy/:id/issue
Issue a Policy
If you have trouble configuring your product to retrieve a quote ID, feel free to contact us at su[email protected] or on Slack.
post
https://api.tint.ai
/v2/policy/:id/report-usage
Report a Policy Usage
You can also report usage without any existing policy, calling the /v2/policy/report-usage endpoint (without any policy ID). This is especially useful if you don't need any quotes or decisions.
post
https://api.tint.ai
/v2/policy/:id/cancel
Cancel a Policy
When a policy is cancelled, it cannot be re-enabled. Instead, you have to create a new policy. 
You can request the cancellation to be effective at a later date by specifying cancellation_effective_at.
You can also set a cancellation notice for all policies (e.g. 30 days) by contacting your Insurance Program Manager. If that is set, all cancellation requests will be effective after the notice occurred.
post
https://api.tint.ai
/v2/policy/:id/payment
Report a Policy Payment 
Let's assume your policy has a monthly renewal. If one of your customer pays you two months at the same time, you would send twice the same date, but two different billing_period_start_date fields,  each of them being the start of the two paid months.
post
https://api.tint.ai
/v2/policy/:id/void
Void a Policy
Voiding a policy cancels all its financial implications. It is used to fix the mistaken issuance of a policy, and assumes a refunding of all paid amounts. Only policies that have been issued before can be voided. Policies that have claims attached cannot be voided.

Document

Endorsements

Last modified 3mo ago

Copy link

On this page

get

Get Insurance Products

post

Create a Policy

post

Create an Issued Policy

get

Get a Policy

put

Update a Policy

post

Issue a Policy

post

Report a Policy Usage

post

Cancel a Policy

post

Report a Policy Payment

post

Void a Policy