Playground

Playground

Insurance

/api/v1/vendor/insurance

An insurance policy carried by a vendor.

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
vendor_id*stringId of the vendor that carries this policy (e.g. 'sup_01HXABC').
type*enumgeneral_liability | professional_liability | cyber | workers_comp | epl | property | otherInsurance coverage type.
carrierstringInsurance carrier (e.g. 'AIG').
policy_numberstringPolicy number (e.g. 'POL-2026-12345').
coverage_amountnumberCoverage limit (e.g. 5000000).
effective_datedate-timeISO 8601 policy effective date.
expiration_datedate-timeISO 8601 policy expiration date.
statusenumactive | expired | pending | cancelledPolicy status. Defaults to 'active'.
document_urlstringURL of the certificate of insurance.

API

client.vendor.insurance.*
Loading manifest…