{ "info": { "_postman_id": "a101cb51-213e-4741-ac07-f70e00afc885", "name": "API Reference Associated Persons policyAmendmentIntents API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:02:21.000Z", "updatedAt": "2026-07-28T02:02:21.000Z", "lastUpdatedBy": "35240", "uid": "35240-a101cb51-213e-4741-ac07-f70e00afc885" }, "item": [ { "name": "policies", "item": [ { "name": "{policy_id}", "item": [ { "name": "policy_amendment_intents", "item": [ { "name": "{policy_amendment_intent_id}", "item": [ { "name": "confirm", "item": [ { "name": "Confirm policy amendment intent", "id": "6fa8469c-b85c-42ef-a9c3-b2a9df9a0395", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:policy_amendment_intent_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":policy_amendment_intent_id", "confirm" ], "variable": [ { "id": "ddf96c80-05c5-4aa4-b118-da6b9935471c", "key": "policy_id", "value": "", "description": "(Required) " }, { "id": "30d4ffae-15f8-4b12-8d1c-36f59d280105", "key": "policy_amendment_intent_id", "value": "", "description": "(Required) " } ] }, "description": "Confirms a policy amendment intent after the employee has reviewed and accepted the quote. The intent must be in `pending_confirmation` status with a valid quote. The confirmation deadline must not have passed." }, "response": [ { "id": "d6fdd795-aa0b-491f-924e-ac2a700ddf7a", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:policy_amendment_intent_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":policy_amendment_intent_id", "confirm" ], "variable": [ { "key": "policy_id" }, { "key": "policy_amendment_intent_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-d6fdd795-aa0b-491f-924e-ac2a700ddf7a" }, { "id": "7c78c490-ce00-4ca1-980c-61840a49f317", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:policy_amendment_intent_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":policy_amendment_intent_id", "confirm" ], "variable": [ { "key": "policy_id" }, { "key": "policy_amendment_intent_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-7c78c490-ce00-4ca1-980c-61840a49f317" }, { "id": "37cbb050-5e31-4182-b78d-f694f6f235cf", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:policy_amendment_intent_id/confirm", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":policy_amendment_intent_id", "confirm" ], "variable": [ { "key": "policy_id" }, { "key": "policy_amendment_intent_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-37cbb050-5e31-4182-b78d-f694f6f235cf" } ], "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-6fa8469c-b85c-42ef-a9c3-b2a9df9a0395" } ], "id": "33937546-5350-41fe-87f0-837247b7a99e", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-33937546-5350-41fe-87f0-837247b7a99e" }, { "name": "Retrieve a policy amendment intent", "id": "f92cbcd1-e964-4011-8334-85aa812fb6d4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:policy_amendment_intent_id", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":policy_amendment_intent_id" ], "variable": [ { "id": "c2f1131d-d443-4492-ae6e-04b9fa934382", "key": "policy_id", "value": "", "description": "(Required) " }, { "id": "27095fe4-1ec1-4632-bba2-f6fb58bea486", "key": "policy_amendment_intent_id", "value": "", "description": "(Required) " } ] }, "description": "Retrieves a `policy_amendment_intent` object." }, "response": [ { "id": "4a329f3d-ad50-45e8-807d-fcafa0f79507", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:policy_amendment_intent_id", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":policy_amendment_intent_id" ], "variable": [ { "key": "policy_id" }, { "key": "policy_amendment_intent_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"policy_id\": \"\",\n \"status\": \"not_undertaken\",\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"dependent_aged_out\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"dependents\"\n },\n {\n \"change_type\": \"cancellation\"\n }\n ],\n \"disclosures\": [\n {\n \"category\": \"provider\",\n \"type\": \"anti_selection_notice\",\n \"text\": \"\"\n },\n {\n \"category\": \"regulatory\",\n \"type\": \"pre_existing_conditions\",\n \"text\": \"\"\n }\n ],\n \"object\": \"\",\n \"required_action\": {\n \"code\": \"provide_dependents_information\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"processing\"\n }\n }\n },\n \"pending_confirmation\": {\n \"code\": \"confirm_qle\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"quote\": {\n \"currency\": \"\",\n \"monthly\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n },\n \"term\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n }\n },\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"processing\"\n }\n }\n },\n \"processing_error\": {\n \"code\": \"unable_to_quote\",\n \"reason\": \"\",\n \"reason_description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-4a329f3d-ad50-45e8-807d-fcafa0f79507" }, { "id": "c4a5e555-0d11-4a07-90f4-2ac9080dfb36", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:policy_amendment_intent_id", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":policy_amendment_intent_id" ], "variable": [ { "key": "policy_id" }, { "key": "policy_amendment_intent_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-c4a5e555-0d11-4a07-90f4-2ac9080dfb36" } ], "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-f92cbcd1-e964-4011-8334-85aa812fb6d4" } ], "id": "0a95df4b-176b-45cc-8fdd-2f0665238bbb", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-0a95df4b-176b-45cc-8fdd-2f0665238bbb" }, { "name": "{id}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel a policy amendment intent", "id": "9c237d4f-ee9f-4339-a26b-4ce088c29d0d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "cancel" ], "variable": [ { "id": "23a55daa-2090-4811-94b1-e727ac53df12", "key": "policy_id", "value": "", "description": "(Required) " }, { "id": "81d342b4-0c08-49f7-9e64-8fec87f218f3", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Cancels a policy amendment intent when the employee decides not to proceed. Can only cancel intents in `action_required` or `pending_confirmation` status." }, "response": [ { "id": "56387228-38e6-42b5-bb60-a0e2720e8918", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "cancel" ], "variable": [ { "key": "policy_id" }, { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-56387228-38e6-42b5-bb60-a0e2720e8918" }, { "id": "3941c093-20c6-4435-af0f-0fff739ce907", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "cancel" ], "variable": [ { "key": "policy_id" }, { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-3941c093-20c6-4435-af0f-0fff739ce907" }, { "id": "c875aeda-f963-4841-9df9-fa05b62474e4", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/cancel", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "cancel" ], "variable": [ { "key": "policy_id" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-c875aeda-f963-4841-9df9-fa05b62474e4" } ], "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-9c237d4f-ee9f-4339-a26b-4ce088c29d0d" } ], "id": "d567fc3d-93d5-41e2-b662-12212fceb84a", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-d567fc3d-93d5-41e2-b662-12212fceb84a" }, { "name": "create_dependents_management_intent", "item": [ { "name": "Create a dependents management intent for a policy amendment", "id": "aa6133ee-8d69-499a-b43f-0f56173893c4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/create_dependents_management_intent", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "create_dependents_management_intent" ], "variable": [ { "id": "bc137419-fd71-47e9-b5f6-7ac41cade718", "key": "policy_id", "value": "", "description": "(Required) " }, { "id": "bdbb883a-a977-4d0c-8279-d3c8c4a493ba", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Creates a dependents management intent as a sub-intent of a policy amendment intent. The sub-intent allows the platform to add or remove dependents from the policy. The policy amendment intent must be in `action_required` status with a `dependents` requested change." }, "response": [ { "id": "d940d75c-4909-4f36-ba61-e92e587bf1a2", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/create_dependents_management_intent", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "create_dependents_management_intent" ], "variable": [ { "key": "policy_id" }, { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"parent_intent_id\": \"\",\n \"parent_intent_type\": \"policy_amendment_intent\",\n \"status\": \"not_undertaken\",\n \"dependents\": [\n {\n \"associated_person_id\": \"\",\n \"status\": \"processing\",\n \"coverage_selections\": [\n {\n \"configuration_id\": \"\",\n \"options\": [\n {\n \"option_id\": \"\",\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"option_id\": \"\",\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"configuration_id\": \"\",\n \"options\": [\n {\n \"option_id\": \"\",\n \"sub_options\": null\n },\n {\n \"option_id\": \"\",\n \"sub_options\": null\n }\n ]\n }\n ],\n \"requirement_id\": \"\"\n },\n {\n \"associated_person_id\": \"\",\n \"status\": \"restricted\",\n \"coverage_selections\": [\n {\n \"configuration_id\": \"\",\n \"options\": [\n {\n \"option_id\": \"\",\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"option_id\": \"\",\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"configuration_id\": \"\",\n \"options\": [\n {\n \"option_id\": \"\",\n \"sub_options\": null\n },\n {\n \"option_id\": \"\",\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"requirement_id\": \"\"\n }\n ],\n \"plan\": {\n \"id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"pricing\": {\n \"type\": \"tier_based\",\n \"per_member\": {\n \"currency\": \"xcd\",\n \"member_type_pricing\": [\n {\n \"code\": \"child\",\n \"display_name\": \"\",\n \"monthly_premium\": \"\"\n },\n {\n \"code\": \"child\",\n \"display_name\": \"\",\n \"monthly_premium\": \"\"\n }\n ]\n },\n \"tier_based\": {\n \"currency\": \"tmt\",\n \"tiers\": [\n {\n \"code\": \"family\",\n \"display_name\": \"\",\n \"monthly_premium\": \"\",\n \"annual_premium\": \"\",\n \"display_dependent_requirements\": \"\"\n },\n {\n \"code\": \"family\",\n \"display_name\": \"\",\n \"monthly_premium\": \"\",\n \"annual_premium\": \"\",\n \"display_dependent_requirements\": \"\"\n }\n ]\n }\n }\n },\n \"disclosures\": [\n {\n \"category\": \"regulatory\",\n \"type\": \"pre_existing_conditions\",\n \"text\": \"\"\n },\n {\n \"category\": \"regulatory\",\n \"type\": \"statement_of_needs\",\n \"text\": \"\"\n }\n ],\n \"object\": \"\",\n \"coverage_options\": null,\n \"action_required\": {\n \"code\": \"remove_restricted_or_ineligible_dependents\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\"\n }\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-d940d75c-4909-4f36-ba61-e92e587bf1a2" }, { "id": "c9babf34-8b97-4dc2-94ae-0b272c1c8d75", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/create_dependents_management_intent", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "create_dependents_management_intent" ], "variable": [ { "key": "policy_id" }, { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-c9babf34-8b97-4dc2-94ae-0b272c1c8d75" }, { "id": "796853c9-ed7d-424b-869d-a21da48e562b", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents/:id/create_dependents_management_intent", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents", ":id", "create_dependents_management_intent" ], "variable": [ { "key": "policy_id" }, { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-796853c9-ed7d-424b-869d-a21da48e562b" } ], "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-aa6133ee-8d69-499a-b43f-0f56173893c4" } ], "id": "fb836881-dcd2-476b-9607-8794538a16fb", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-fb836881-dcd2-476b-9607-8794538a16fb" } ], "id": "47c62c77-c000-4618-8bde-1cfa26ddccb0", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-47c62c77-c000-4618-8bde-1cfa26ddccb0" }, { "name": "List all policy amendment intents for a policy", "id": "8626bf5c-1729-49a4-9dcf-767d3ebe2382", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents?status=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "query": [ { "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `action_required`, `awaiting_quote`, `pending_confirmation`, `processing`, `amended`, `processing_error`, `not_undertaken`.", "key": "status", "value": "" }, { "description": "The page of results to return. Defaults to 1 if not provided.", "key": "page", "value": "" }, { "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "key": "page_size", "value": "" } ], "variable": [ { "id": "80708333-2de0-4a72-b603-b6faa49f3d56", "key": "policy_id", "value": "", "description": "(Required) " } ] }, "description": "Returns a paginated list of policy amendment intents for the specified policy. The intents are returned sorted by creation date, with the oldest intent appearing first." }, "response": [ { "id": "aa9c7fc1-3c17-4f87-867c-437cd487a4ff", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents?status=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "query": [ { "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `action_required`, `awaiting_quote`, `pending_confirmation`, `processing`, `amended`, `processing_error`, `not_undertaken`.", "key": "status", "value": "" }, { "description": "The page of results to return. Defaults to 1 if not provided.", "key": "page", "value": "" }, { "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "key": "page_size", "value": "" } ], "variable": [ { "key": "policy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"policy_id\": \"\",\n \"status\": \"processing_error\",\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"adoption_of_child\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"cancellation\"\n },\n {\n \"change_type\": \"cancellation\"\n }\n ],\n \"disclosures\": [\n {\n \"category\": \"intermediary\",\n \"type\": \"intermediary_role\",\n \"text\": \"\"\n },\n {\n \"category\": \"provider\",\n \"type\": \"intermediary_commission\",\n \"text\": \"\"\n }\n ],\n \"object\": \"\",\n \"required_action\": {\n \"code\": \"provide_dependents_information\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"processing\"\n }\n }\n },\n \"pending_confirmation\": {\n \"code\": \"confirm_quote\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"quote\": {\n \"currency\": \"\",\n \"monthly\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n },\n \"term\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n }\n },\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"not_undertaken\"\n }\n }\n },\n \"processing_error\": {\n \"code\": \"unable_to_quote\",\n \"reason\": \"\",\n \"reason_description\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"policy_id\": \"\",\n \"status\": \"processing\",\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"employment_status_change_affecting_eligibility\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"cancellation\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ],\n \"disclosures\": [\n {\n \"category\": \"regulatory\",\n \"type\": \"statement_of_needs\",\n \"text\": \"\"\n },\n {\n \"category\": \"provider\",\n \"type\": \"intermediary_role\",\n \"text\": \"\"\n }\n ],\n \"object\": \"\",\n \"required_action\": {\n \"code\": \"provide_dependents_information\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"not_undertaken\"\n }\n }\n },\n \"pending_confirmation\": {\n \"code\": \"confirm_qle\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"quote\": {\n \"currency\": \"\",\n \"monthly\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n },\n \"term\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n }\n },\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"processing\"\n }\n }\n },\n \"processing_error\": {\n \"code\": \"unable_to_quote\",\n \"reason\": \"\",\n \"reason_description\": \"\"\n }\n }\n ],\n \"page\": \"\",\n \"page_size\": \"\",\n \"total_count\": \"\",\n \"has_next_page\": \"\",\n \"has_previous_page\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-aa9c7fc1-3c17-4f87-867c-437cd487a4ff" }, { "id": "c420645c-647f-4e9b-a19d-bac9208f1161", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents?status=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "query": [ { "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `action_required`, `awaiting_quote`, `pending_confirmation`, `processing`, `amended`, `processing_error`, `not_undertaken`.", "key": "status", "value": "" }, { "description": "The page of results to return. Defaults to 1 if not provided.", "key": "page", "value": "" }, { "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "key": "page_size", "value": "" } ], "variable": [ { "key": "policy_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-c420645c-647f-4e9b-a19d-bac9208f1161" }, { "id": "9de642b7-7888-415e-91bd-7fc9b660e889", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents?status=&page=&page_size=", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "query": [ { "description": "Multiple values can be provided by separating them with a comma. Allowed values are: `action_required`, `awaiting_quote`, `pending_confirmation`, `processing`, `amended`, `processing_error`, `not_undertaken`.", "key": "status", "value": "" }, { "description": "The page of results to return. Defaults to 1 if not provided.", "key": "page", "value": "" }, { "description": "The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.", "key": "page_size", "value": "" } ], "variable": [ { "key": "policy_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-9de642b7-7888-415e-91bd-7fc9b660e889" } ], "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-8626bf5c-1729-49a4-9dcf-767d3ebe2382" }, { "name": "Create a new policy amendment intent", "id": "7015d32e-bd7b-4cd5-baed-d7d930779339", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"dependent_gained_other_coverage\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"cancellation\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "variable": [ { "id": "6c2b6720-c895-4905-9819-9c8b6acbeab4", "key": "policy_id", "value": "", "description": "(Required) " } ] }, "description": "Initiates a policy amendment (e.g. adding/removing dependents). The intent coordinates the amendment workflow including dependents sub-intent management, quote generation, employee confirmation, and provider processing." }, "response": [ { "id": "6702991c-1e66-41b4-bbb9-5ac2da7b564e", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"dependent_gained_other_coverage\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"cancellation\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "variable": [ { "key": "policy_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"policy_id\": \"\",\n \"status\": \"not_undertaken\",\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"dependent_aged_out\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"dependents\"\n },\n {\n \"change_type\": \"cancellation\"\n }\n ],\n \"disclosures\": [\n {\n \"category\": \"provider\",\n \"type\": \"anti_selection_notice\",\n \"text\": \"\"\n },\n {\n \"category\": \"regulatory\",\n \"type\": \"pre_existing_conditions\",\n \"text\": \"\"\n }\n ],\n \"object\": \"\",\n \"required_action\": {\n \"code\": \"provide_dependents_information\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"processing\"\n }\n }\n },\n \"pending_confirmation\": {\n \"code\": \"confirm_qle\",\n \"reason\": \"\",\n \"reason_description\": \"\",\n \"due_by\": \"\",\n \"quote\": {\n \"currency\": \"\",\n \"monthly\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n },\n \"term\": {\n \"employee_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"employer_contribution\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n },\n \"total\": {\n \"net\": \"\",\n \"tax\": \"\",\n \"gross\": \"\"\n }\n }\n },\n \"associated_persons\": {\n \"type\": \"dependents\",\n \"dependents\": {\n \"dependents_management_intent_id\": \"\",\n \"status\": \"processing\"\n }\n }\n },\n \"processing_error\": {\n \"code\": \"unable_to_quote\",\n \"reason\": \"\",\n \"reason_description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-6702991c-1e66-41b4-bbb9-5ac2da7b564e" }, { "id": "463d978c-3ab6-4de3-8516-48dc8d4150be", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"dependent_gained_other_coverage\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"cancellation\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "variable": [ { "key": "policy_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-463d978c-3ab6-4de3-8516-48dc8d4150be" }, { "id": "03154cc7-019a-4f53-9eee-475c5dd7aa7b", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"event\": \"dependent_gained_other_coverage\",\n \"event_date\": \"\",\n \"reason\": \"\"\n }\n },\n \"requested_changes\": [\n {\n \"change_type\": \"cancellation\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/policies/:policy_id/policy_amendment_intents", "host": [ "{{baseUrl}}" ], "path": [ "policies", ":policy_id", "policy_amendment_intents" ], "variable": [ { "key": "policy_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\"\n}", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-03154cc7-019a-4f53-9eee-475c5dd7aa7b" } ], "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-7015d32e-bd7b-4cd5-baed-d7d930779339" } ], "id": "6e41da50-1df8-4340-8bde-340729287a53", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-6e41da50-1df8-4340-8bde-340729287a53" } ], "id": "e7263185-d7ab-4e18-ae80-95a02061266d", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-e7263185-d7ab-4e18-ae80-95a02061266d" } ], "id": "1d7ab352-1558-4bef-bb22-4c784dfec5b0", "createdAt": "2026-07-28T02:02:22.000Z", "updatedAt": "2026-07-28T02:02:22.000Z", "uid": "35240-1d7ab352-1558-4bef-bb22-4c784dfec5b0" } ], "variable": [ { "key": "baseUrl", "value": "https://test.api.kota.io" } ] }