REFERENCE  ·  INSUREDS AND COVERAGE

PUT /v1/insureds/{insured_ref}

Upsert identity. Optional; the first document creates the insured if absent.

PARAMETERS
NAMETYPEREQUIREDDESCRIPTION
insured_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
aliases string[] no Other names the insured goes by, each 1 to 200 characters, trimmed and deduplicated. Replaces the aliases you set before; aliases read from documents stay. [] clears yours; omitted leaves them
entity_kind enum no business, individual.
parent_insured_ref string no A contractor operating under a company is a child of that company
identifiers object no ein, usdot, mc, state_license…
address string no
contacts string[] no
contact object no Your contact for the insured, kept per customer: another customer of Insurance Verified never sees or changes it. A field you have not set reads as what Insurance Verified confirmed at the source, when it has. A field sent as "" clears your value.
RESPONSE
FIELDTYPEDESCRIPTION
insured_ref string
name string
aliases string[]
entity_kind enum business, individual.
parent_insured_ref string Set when this insured is a child (e.g. a contractor operating under a company)
children string[] insured_refs of insureds whose parent_insured_ref is this insured
identifiers object
address string
contacts string[]
contact object Your contact for the insured, kept per customer: another customer of Insurance Verified never sees or changes it. A field you have not set reads as what Insurance Verified confirmed at the source, when it has. A field sent as "" clears your value.
documents object[]
coverage_lines object[]
open_requests string[]
latest_verdict_per_consumer object[]
enrollments object[] The insured's program enrollments on this account (4.5.1)

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

Changelog  ·  Versioning and notice terms  ·  Status