REFERENCE · CONSUMERS AND REQUIREMENT SETS

POST /v1/consumers/{consumer_ref}/requirement-sets/{version}/preview

Impact of publishing. applies_to, grace_period_days → engagements newly failing (by rule), lines needing fresh confirmation, engagements unaffected.

PARAMETERS

NAME	TYPE	REQUIRED	DESCRIPTION
consumer_ref	string	yes
version	string	yes
Idempotency-Key	string	no	Optional, and the preferred way to make a retry safe. Send one on every POST and PUT; a replay returns the original response with idempotent_replay true and creates nothing new. POST /documents also accepts an idempotency_key form field as an alias; the header wins when both are sent
applies_to	enum	yes	new (engagements opened from now on) or all_active (every active engagement for the consumer) One of: new, all_active.
grace_period_days	integer	no

RESPONSE

FIELD	TYPE	DESCRIPTION
engagements_newly_failing	object[]
lines_needing_confirmation	string[]
engagements_unaffected	integer

Errors: 400, 401, 403, 404, 422, 429, 500. Every error body carries error.code, error.message, and error.request_id.

curl -X POST "https://api.insuranceverified.ai/v1/consumers/…/requirement-sets/…/preview" \ -H "Authorization: Bearer ive_live_…" \ -H "Idempotency-Key: …" \ -H "Content-Type: application/json" \ -d '{ "applies_to": "new", "grace_period_days": 0 }'

import requests url = "https://api.insuranceverified.ai/v1/consumers/…/requirement-sets/…/preview" headers = { "Authorization": "Bearer ive_live_…", "Idempotency-Key": "…", } payload = { "applies_to": "new", "grace_period_days": 0 } response = requests.post(url, headers=headers, json=payload) print(response.status_code, response.json())

const url = "https://api.insuranceverified.ai/v1/consumers/…/requirement-sets/…/preview"; const response = await fetch(url, { method: "POST", headers: { "Authorization": "Bearer ive_live_…", "Idempotency-Key": "…", "Content-Type": "application/json" }, body: JSON.stringify({ "applies_to": "new", "grace_period_days": 0 }), }); console.log(response.status, await response.json());