End-to-end integration

Build a complete insurance flow into your app, from setting up your business to your first live sale. Each step below has its own page with the calls to make, in order.

The journeylink

Step	What you do	Main calls
1. Set up your business	Create your business, verify it, create a test key.	Merchant dashboard
2. Show products	Find what your business may sell and line products up.	`GET /taxonomy`, `GET /products`, `POST /compare`
3. Collect the quote form	Render the insurer's form and collect your customer's answers.	`GET /products/{providerId}/{productId}/form`
4. Price a quote	Get the insurer's firm price.	`POST /quotes`
5. Take payment and buy	Charge your customer, then buy the policy.	`POST /purchases`
6. Receive webhooks	Learn when quotes, policies and claims change.	`POST /webhook-endpoints`
7. Service the policy	Documents, changes, renewals and cancellations.	`/policies/...`
8. Handle claims	File, follow, appeal or withdraw claims.	`POST /uploads`, `/claims/...`
9. Settle your statement	Pay what you collected, less refunds and your commission.	`GET /statements`
10. Test and go live	Finish the activation checklist and switch to a live key.	Merchant dashboard

Build every step with a test key first. Nothing you do in test issues real cover or moves real money.

The ids you keeplink

Store these as you go. Most calls need two of them.

Id	Where it comes from	What you use it for
`providerId`	Every product	The insurer. Almost every call needs it.
`productId`	`GET /products`	Reading, comparing and quoting a product.
`formId`, `formVersion`	The product's form	Quoting, claiming and endorsing.
`quoteId`	`POST /quotes`	Buying the quote.
`purchaseId`	`POST /purchases`	Following the purchase and reporting installments.
`policyId`	The purchase, once issued	Reading, changing, renewing, cancelling and claiming on the policy.
`fileId`	`POST /uploads`	Attaching evidence to a claim.
`claimId`	`POST /claims`	Following, adding to, appealing and withdrawing the claim.
`statementId`	The purchase, once billed	Reconciling what you owe.

A sale in five callslink

The shortest happy path, once your business is set up:

GET  /products?productType=MOTOR_COMPREHENSIVE          pick a product
GET  /products/{providerId}/{productId}/form?context=quote   render the form
POST /quotes                                            get the price
     (charge your customer quote.totalMinor yourself)
POST /purchases                                         buy the policy
GET  /policies/{providerId}/{policyId}                  show the policy

Everything after the sale (renewals, changes, cancellations, claims and statements) builds on the providerId and policyId you keep from this path.