Credit Life
Credit life pays off a borrower's outstanding loan balance if they die, to you as the lender.
Cover is arranged as a policy — one agreement covering many borrowers — and borrowers go on cover in batches. Every term and rate is the insurer's; you do not price anything, so there is no quotation to raise and no quote-and-issue flow. What does carry over from the other products is the payment split: see Premium models.
Every step in this section is runnable. Set your key once, fill in the request, press Try it out, and read the real response without leaving the page — see Running requests from the guide.
Set it once and every Try it out below is authenticated. It stays in this browser's local storage and is never sent anywhere but the API.
The workflow
| Page | What it covers |
|---|---|
| Products | The credit-life products you are authorised to sell, and their terms |
| Buying cover | One call that registers the client, opens the policy and puts borrowers on cover |
| Premium models | Prepaid vs remittance, and paying a batch's premium |
| Adding borrowers | Pricing, single loans, batches, and the premium register |
| Renewals | Cover state, arrears, and carrying loans into a new period |
| Early settlement | Taking early-repaid loans off cover and refunding unearned premium |
| Claims | Intimating claims, attaching documents, tracking outcomes |
Notes
- Rates are the insurer's. There is no endpoint for you to raise or price a quotation; the quotations list is read-only, and an empty list means onboarding with the insurer is unfinished.
- Ids are opaque strings. Do not parse them or assume they are numeric.
- No webhooks yet — poll for status changes.
/credit-life/quotationsPlayground
Authorization
Variables
Full request and response detail for every endpoint in this section is in the API Reference.
