Octamile AIMS — Partner Integration Documentation¶
This is the authoritative integration documentation for the Octamile AIMS embedded insurance API.
Quick Links¶
| URL | |
|---|---|
| Developer Docs | https://gentle-island-073c6ac0f.7.azurestaticapps.net |
| Partner Dashboard | https://octamile-dashboard.azurewebsites.net |
| API Base URL | https://octamile-api.azurewebsites.net |
Try it now: Log in to the Partner Dashboard to run a live quote, purchase a policy, and retrieve a certificate — no code needed.
Start Here¶
If you are integrating for the first time, read in this order:
- Quickstart Guide — Complete end-to-end walkthrough with working cURL examples. Gets you to a working policy purchase in under 30 minutes.
- Authentication Guide — How to set up and use your credentials.
- API Reference — Single endpoint, command syntax, status codes, transaction ID requirements.
Product Guides¶
Detailed integration instructions per product, including product-specific fields and cURL examples for every step.
| Product | Guide |
|---|---|
| Vehicle Insurance (Third-party & Comprehensive) | guides/vehicle/vehicle-insurance.md |
| Phone & Laptop Warranty | guides/device/device-warranty.md |
| Travel Insurance (International) | guides/travel/travel-insurance.md |
| Goods-in-Transit Insurance | guides/logistics/goods-in-transit.md |
| Loan Repayment Guaranty | guides/lending/loan-repayment-guaranty.md |
| Health Insurance (Option X1) | guides/health/health-insurance.md |
| Marine Insurance (Export & Import) | guides/marine/marine-insurance.md |
Reference¶
| Topic | Document |
|---|---|
| Webhooks | webhooks/webhook-reference.md |
| API command reference | api-reference/overview.md |
Key Facts Every Integration Must Know¶
Single endpoint. All requests go to POST https://octamile-api.azurewebsites.net. There are no separate URLs per product or action.
Always HTTP 200. Success or failure is determined by exctnFdbck.id in the response body — not the HTTP status code. "75" = success, "55" = error, "35" = retry.
Collect payment before requesting a policy. Call Step 3 only after you have charged the consumer the premium from Step 1.
Store the consumer ID and transaction reference. You need both for status checks, claims, and all future requests for that consumer.
Certificates are Base64. Decode the crtfct field before storing or displaying it.
API Base URL¶
Support¶
Contact Octamile support with your partner ID and the relevant transaction ID when reporting issues.