{ "info": { "_postman_id": "fef84b36-f114-4c40-83fa-15d0ce644830", "name": "API Reference Associated Persons Policy Amendment Intents API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:02:19.000Z", "updatedAt": "2026-07-28T02:02:19.000Z", "lastUpdatedBy": "35240", "uid": "35240-fef84b36-f114-4c40-83fa-15d0ce644830" }, "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": "cd2e03d4-fa43-4440-9c1f-3176a28b882c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/problem+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": "0179737b-84ea-4ae7-96f2-9ee140690c36", "key": "policy_id", "value": "p_[", "description": "(Required) " }, { "id": "8ce06bb4-a490-4845-ac1b-479777ee9454", "key": "policy_amendment_intent_id", "value": "pai_Lz={d*", "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": "1f1ddb27-0413-4a09-b812-4e3758f91d6e", "name": "No Content", "originalRequest": { "method": "POST", "header": [], "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": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-1f1ddb27-0413-4a09-b812-4e3758f91d6e" }, { "id": "cb070cd9-966e-4884-a51b-e6b9ac60015d", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/problem+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/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-cb070cd9-966e-4884-a51b-e6b9ac60015d" }, { "id": "912aced1-2d03-4a17-b8cf-1c915e17e954", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/problem+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/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-912aced1-2d03-4a17-b8cf-1c915e17e954" } ], "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-cd2e03d4-fa43-4440-9c1f-3176a28b882c" } ], "id": "78c45963-8b1d-467d-8036-161b62ea369f", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-78c45963-8b1d-467d-8036-161b62ea369f" }, { "name": "Retrieve a policy amendment intent", "id": "be424349-149f-40c2-9e84-1529045af645", "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": "085815db-4a9d-44ce-8f98-56ea39a88487", "key": "policy_id", "value": "p_[", "description": "(Required) " }, { "id": "59006f43-10d3-4df9-8d69-8f98d36aeb04", "key": "policy_amendment_intent_id", "value": "pai_Lz={d*", "description": "(Required) " } ] }, "description": "Retrieves a `policy_amendment_intent` object." }, "response": [ { "id": "0a07b4d5-6814-4f34-8478-4df086884328", "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 \"amendment_reason\": {\n \"type\": \"initial_adjustment_period\",\n \"qualifying_life_event\": {\n \"value\": \"\",\n \"type\": \"product_information\"\n },\n {\n \"category\": \"intermediary\",\n \"text\": \"\",\n \"type\": \"intermediary_role\"\n }\n ],\n \"id\": \"pai_-'&x\",\n \"policy_id\": \"p_oh(5f\",\n \"requested_changes\": [\n {\n \"change_type\": \"dependents\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ],\n \"status\": \"amended\",\n \"object\": \"\",\n \"required_action\": {\n \"value\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-8034e65c-0af7-4466-a05d-9d750b7e9c20" } ], "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-be424349-149f-40c2-9e84-1529045af645" } ], "id": "4bd45ba4-e704-4610-ad48-dd2138ff6771", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-4bd45ba4-e704-4610-ad48-dd2138ff6771" }, { "name": "{id}", "item": [ { "name": "cancel", "item": [ { "name": "Cancel a policy amendment intent", "id": "f38b7879-a2c0-47a1-b1ef-6814fa55b01a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/problem+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": "8159e0c1-b9de-42cc-8b6c-301ab7e3b0be", "key": "policy_id", "value": "p_[", "description": "(Required) " }, { "id": "8f81cf0f-dd5f-4c38-a036-882eeb198571", "key": "id", "value": "pai_Lz={d*", "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": "6290c88b-c7aa-4f67-996d-dd1d4e3fc36f", "name": "No Content", "originalRequest": { "method": "POST", "header": [], "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": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-6290c88b-c7aa-4f67-996d-dd1d4e3fc36f" }, { "id": "d7fe7397-daf8-4e65-872e-de2620d175c6", "name": "Bad Request", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/problem+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/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-d7fe7397-daf8-4e65-872e-de2620d175c6" }, { "id": "e88efc24-e0a5-4312-8578-c5d3e9f99d3d", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/problem+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/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-e88efc24-e0a5-4312-8578-c5d3e9f99d3d" } ], "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-f38b7879-a2c0-47a1-b1ef-6814fa55b01a" } ], "id": "3ac050e3-83c4-4487-95b9-3d76dc1c9683", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-3ac050e3-83c4-4487-95b9-3d76dc1c9683" }, { "name": "create_dependents_management_intent", "item": [ { "name": "Create a dependents management intent for a policy amendment", "id": "39a8cbdc-897d-4da6-87a6-c3ba755b8433", "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": "a331f678-d522-4c71-bf99-21973b06dee3", "key": "policy_id", "value": "p_[", "description": "(Required) " }, { "id": "2372f6eb-88b6-4181-89b1-4b2390f05d92", "key": "id", "value": "pai_Lz={d*", "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": "2d0fe1a3-4b56-416d-b82a-3b15fb5f0f93", "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 \"dependents\": [\n {\n \"associated_person_id\": \"ap_Omef4.kor,N\",\n \"status\": \"restricted\",\n \"coverage_selections\": [\n {\n \"configuration_id\": \"pc_7Y[*)ex05<\",\n \"options\": [\n {\n \"option_id\": \"pco_$\",\n \"sub_options\": null\n },\n {\n \"option_id\": \"pco_wx&U(yU\",\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"configuration_id\": \"pc_[#H?5iDRq*\",\n \"options\": [\n {\n \"option_id\": \"pco_W wrr?.'}p\",\n \"sub_options\": null\n },\n {\n \"option_id\": \"pco_}z!TNb\",\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"requirement_id\": \"\"\n },\n {\n \"associated_person_id\": \"ap_L?ol8\",\n \"status\": \"restricted\",\n \"coverage_selections\": null,\n \"requirement_id\": \"\"\n }\n ],\n \"disclosures\": [\n {\n \"category\": \"regulatory\",\n \"text\": \"\",\n \"type\": \"statement_of_needs\"\n },\n {\n \"category\": \"regulatory\",\n \"text\": \"\",\n \"type\": \"intermediary_role\"\n }\n ],\n \"id\": \"dmi_^'~l$NcTM\",\n \"parent_intent_id\": \"\",\n \"parent_intent_type\": \"enrolment_intent\",\n \"plan\": {\n \"description\": \"\",\n \"id\": \"pl_h*1F?ijuXCt\",\n \"name\": \"\",\n \"pricing\": {\n \"type\": \"tier_based\",\n \"per_member\": {\n \"value\": \"\",\n \"coverage_options\": [\n {\n \"id\": \"pc_{X*$|F\",\n \"input_type\": \"multi_select\",\n \"name\": \"\",\n \"options\": [\n {\n \"id\": \"pco_{>dBK)\",\n \"name\": \"\",\n \"description\": \"\",\n \"learn_more_url\": \"\",\n \"from_price\": \"\",\n \"benefits\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"sub_options\": null,\n \"eligibility_criteria\": [\n {\n \"description\": \"\",\n \"type\": \"members_count\",\n \"employees_count\": {\n \"value\": \"\",\n \"type\": \"members_count\",\n \"employees_count\": {\n \"value\": \"\",\n \"description\": \"\",\n \"learn_more_url\": \"\",\n \"from_price\": \"\",\n \"benefits\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"eligibility_criteria\": null\n }\n ],\n \"required\": \"\",\n \"scope\": \"group_policy\",\n \"description\": \"\",\n \"min_selections\": \"\",\n \"max_selections\": \"\",\n \"sort_order\": \"\",\n \"group_label\": \"\"\n },\n {\n \"id\": \"pc_,[@ot; \",\n \"input_type\": \"single_select\",\n \"name\": \"\",\n \"options\": [\n {\n \"id\": \"pco_ZF\",\n \"name\": \"\",\n \"description\": \"\",\n \"learn_more_url\": \"\",\n \"from_price\": \"\",\n \"benefits\": null,\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"eligibility_criteria\": null\n },\n {\n \"id\": \"pco_F2cx\",\n \"name\": \"\",\n \"description\": \"\",\n \"learn_more_url\": \"\",\n \"from_price\": \"\",\n \"benefits\": [\n {\n \"name\": \"\",\n \"description\": \"\"\n },\n {\n \"name\": \"\",\n \"description\": \"\"\n }\n ],\n \"sub_options\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"eligibility_criteria\": [\n {\n \"description\": \"\",\n \"type\": \"industry_exclusions\",\n \"employees_count\": {\n \"value\": \"\",\n \"type\": \"industry_exclusions\",\n \"employees_count\": {\n \"value\": \"\",\n \"scope\": \"group_policy\",\n \"description\": \"\",\n \"min_selections\": \"\",\n \"max_selections\": \"\",\n \"sort_order\": \"\",\n \"group_label\": \"\"\n }\n ],\n \"action_required\": {\n \"value\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-fd46da4e-9dd6-49ae-be25-7092da265ccb" }, { "id": "9554e32d-beb9-4059-8aa7-606969ab8d57", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/problem+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/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-9554e32d-beb9-4059-8aa7-606969ab8d57" } ], "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-39a8cbdc-897d-4da6-87a6-c3ba755b8433" } ], "id": "745c0ed2-bf51-4162-a62f-678a08d10d76", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-745c0ed2-bf51-4162-a62f-678a08d10d76" } ], "id": "ad2d5719-6f16-46d8-9d97-7f55dec8d584", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-ad2d5719-6f16-46d8-9d97-7f55dec8d584" }, { "name": "List all policy amendment intents for a policy", "id": "ddc3ce00-4b26-40ca-9120-e1990360bacd", "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": "52be497a-25f7-4c38-b3dd-ebdb3b1308d5", "key": "policy_id", "value": "p_[", "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": "b8409f1a-4a8b-422d-b601-a118a1a9866e", "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 \"amendment_reason\": {\n \"type\": \"qualifying_life_event\",\n \"qualifying_life_event\": {\n \"value\": \"\",\n \"type\": \"anti_selection_notice\"\n },\n {\n \"category\": \"provider\",\n \"text\": \"\",\n \"type\": \"pre_existing_conditions\"\n }\n ],\n \"id\": \"pai_2pzRWk\",\n \"policy_id\": \"p_>\",\n \"requested_changes\": [\n {\n \"change_type\": \"dependents\"\n },\n {\n \"change_type\": \"cancellation\"\n }\n ],\n \"status\": \"not_undertaken\",\n \"object\": \"\",\n \"required_action\": {\n \"value\": \"\",\n \"type\": \"underwriter_disclaimer\"\n },\n {\n \"category\": \"regulatory\",\n \"text\": \"\",\n \"type\": \"product_information\"\n }\n ],\n \"id\": \"pai_k,&u@!\",\n \"policy_id\": \"p_{,x45j\",\n \"requested_changes\": [\n {\n \"change_type\": \"cancellation\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ],\n \"status\": \"pending_confirmation\",\n \"object\": \"\",\n \"required_action\": {\n \"value\": \"\",\n \"page_size\": \"\",\n \"total_count\": \"\",\n \"has_next_page\": \"\",\n \"has_previous_page\": \"\"\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-b8409f1a-4a8b-422d-b601-a118a1a9866e" }, { "id": "42d94001-5238-47aa-830a-f40a54bd0108", "name": "Bad Request", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/problem+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/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-42d94001-5238-47aa-830a-f40a54bd0108" }, { "id": "f699e8cb-e57a-4349-bc71-0ed969cbeb85", "name": "Not Found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/problem+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/problem+json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-f699e8cb-e57a-4349-bc71-0ed969cbeb85" } ], "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-ddc3ce00-4b26-40ca-9120-e1990360bacd" }, { "name": "Create a new policy amendment intent", "id": "a423090c-7c93-42f1-8080-5ed9f083d8d1", "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\": \"qualifying_life_event\",\n \"qualifying_life_event\": {\n \"value\": \"\",\n \"type\": \"product_information\"\n },\n {\n \"category\": \"intermediary\",\n \"text\": \"\",\n \"type\": \"intermediary_role\"\n }\n ],\n \"id\": \"pai_-'&x\",\n \"policy_id\": \"p_oh(5f\",\n \"requested_changes\": [\n {\n \"change_type\": \"dependents\"\n },\n {\n \"change_type\": \"dependents\"\n }\n ],\n \"status\": \"amended\",\n \"object\": \"\",\n \"required_action\": {\n \"value\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-28d1d78c-e3da-47da-85d1-9accbdcdc6d1" }, { "id": "104d9858-c2e7-4d3c-b348-2cca9a06eb94", "name": "Not Found", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/problem+json" } ], "body": { "mode": "raw", "raw": "{\n \"amendment_reason\": {\n \"type\": \"qualifying_life_event\",\n \"qualifying_life_event\": {\n \"value\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"minimb\": {},\n \"ind85\": {},\n \"Lorem_f\": {}\n}", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-104d9858-c2e7-4d3c-b348-2cca9a06eb94" } ], "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-a423090c-7c93-42f1-8080-5ed9f083d8d1" } ], "id": "7adaf709-5bed-435b-90f0-f61b7918731b", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-7adaf709-5bed-435b-90f0-f61b7918731b" } ], "id": "bcf91e75-4991-41e6-b052-4fc385c7c1b3", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-bcf91e75-4991-41e6-b052-4fc385c7c1b3" } ], "id": "c31e7b1e-9d3e-4777-a4dc-52ac31ae5316", "createdAt": "2026-07-28T02:02:20.000Z", "updatedAt": "2026-07-28T02:02:20.000Z", "uid": "35240-c31e7b1e-9d3e-4777-a4dc-52ac31ae5316" } ], "variable": [ { "key": "baseUrl", "value": "https://test.api.kota.io" } ] }