REFERENCE · CONSUMERS AND REQUIREMENT SETS

PUT /v1/consumers/{consumer_ref}

Upsert: name, contacts, meta.

PARAMETERS

NAME	TYPE	REQUIRED	DESCRIPTION
consumer_ref	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
name	string	no
contacts	string[]	no
meta	object	no

RESPONSE

FIELD	TYPE	DESCRIPTION
name	string
contacts	string[]
meta	object

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

curl -X PUT "https://api.insuranceverified.ai/v1/consumers/…" \ -H "Authorization: Bearer ive_live_…" \ -H "Idempotency-Key: …" \ -H "Content-Type: application/json" \ -d '{ "name": "…", "contacts": [ "…" ], "meta": {} }'

import requests url = "https://api.insuranceverified.ai/v1/consumers/…" headers = { "Authorization": "Bearer ive_live_…", "Idempotency-Key": "…", } payload = { "name": "…", "contacts": [ "…" ], "meta": {} } response = requests.put(url, headers=headers, json=payload) print(response.status_code, response.json())

const url = "https://api.insuranceverified.ai/v1/consumers/…"; const response = await fetch(url, { method: "PUT", headers: { "Authorization": "Bearer ive_live_…", "Idempotency-Key": "…", "Content-Type": "application/json" }, body: JSON.stringify({ "name": "…", "contacts": [ "…" ], "meta": {} }), }); console.log(response.status, await response.json());