Changelog¶
All notable changes to the Octamile AIMS API are recorded here in reverse chronological order.
Labels: Breaking changes require updates to your integration. New adds functionality without breaking existing integrations. Fixed corrects incorrect behaviour.
2026-05-13¶
Travel Insurance — destination now required in Step 1 quote — Breaking¶
Affected: SR10 (dump ipck_ltix-stnd-1111*PRMM).
destination (the destination country name) is now a required field in the Step 1 quote seed. The coverage zone (Schengen / Area 1 / Area 2) is derived automatically from the destination — the travelPlan field is no longer needed in the quote call.
"seed": {
"insrncDrtn": "15d",
"destination": "France",
"planType": "individual",
"travelerAge": 35
}
Omitting destination returns:
Migration: Add destination to your SR10 seed. Remove travelPlan from the quote — it is ignored.
Travel Insurance — family plan support — New¶
Affected: SR10 and SR15 — ltix-stnd-1111.
planType: "family" is now supported. Family plans cover the primary traveler plus any number of additional travelers listed in a passengers array. Each passenger requires firstName, lastName, dob, and passportNo. See the Travel Insurance Guide for the full request format and field reference.
Travel Insurance — supported destination list — New¶
Affected: SR10 and SR15 — ltix-stnd-1111.
Destinations are now validated against a fixed list of countries supported by the underwriter. Passing a country not on the list returns:
The full list of supported countries is in the Travel Insurance Guide.
2026-05-08¶
eMail now required for all consumers — Breaking¶
Affected: SR05 (prfl entity) — all consumer classes (individual and organisation).
eMail is now a required field. Omitting it returns:
Migration: If you have existing consumers without an email on record, call prfl entity again with the same phoneNo and a valid eMail — the record updates in place.
Cover period validation enforced — Breaking¶
Affected: SR15 (entt_{id}: insure) — all products with insrncDrtn.
Previously, any syntactically valid duration string (e.g. 5m) was accepted even if the product only supports 1y. Invalid cover periods now return:
{ "exctnFdbck": { "id_v4": 406, "elbrtn": "Cover period not one of those supported by this product" } }
Migration: Ensure insrncDrtn matches the supported values listed in each product guide. For example, Third-Party Vehicle (vhcl-tprt-1111) accepts only "1y".
Consumer DOB and gender now validated before NSIA policy issuance — Fixed¶
Affected: SR15 — vhcl-cmpr-1111, vhcl-tprt-1111, allr-stnd-1111, firb-stnd-1111.
Attempting to issue an NSIA policy for a consumer registered without a date of birth or gender now returns a 406 before the request is stored, with a message directing you to update the consumer via prfl entity.
2026-05-05¶
phoneNo now required for individual consumers — Breaking¶
Affected: SR05 (prfl entity) — class: "individual" and class: "h".
phoneNo became a required field for individual consumers. Organisation consumers are not affected.
Marine Export (mexx-stnd-1111) voyage field must be objects — Breaking¶
Affected: SR15 — mexx-stnd-1111.
addtnlFact.voyage must be an array of objects with exactly one key each ("origin" or "destination"). Plain string arrays are rejected with 400.
Correct format:
"voyage": [
{ "origin": "Apapa Port, Lagos, Nigeria" },
{ "destination": "Tema Port, Accra, Ghana" }
]
2026-05-01¶
Device Warranty policies auto-approve with policy number — New¶
Affected: SR15 — phnn-flx1-1111, phnn-flx2-1111, phnn-flx3-1111.
PHNN products now auto-approve immediately on issuance. SR20 returns a policyNo in the format OCT-PHNN-YYYYMMDD-XXXXXXXX. No cert download is available — display the policy number as the certificate reference.
2026-04-29¶
SR05 consumer registration is now idempotent by email — New¶
Affected: SR05 (prfl entity).
Registering a consumer with an email address that already exists in your account returns the existing consumer ID rather than creating a duplicate. This allows safe retry behaviour without accumulating duplicate records.
SR20 response fields moved to top level — Breaking¶
Affected: SR20 (dump entt_*STATUS).
All response fields (status, certUrl, policyNo, crtfct, crtfctType) are now returned at the top level of the response, not nested inside exctnFdbck. Update any code that reads res.exctnFdbck.sngl.status to read res.status instead.
New response shape: