Skip to content
XOS Developers

insuranceCertificates

Vendors module · 5 operations

List insurance certificate rows

GET/insurance-certificates

A certificate of insurance naming the required additional insureds. Returns a cursor page of insurance certificate rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create an insurance certificate

POST/insurance-certificates

A certificate of insurance naming the required additional insureds. Creates an insurance certificate. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get an insurance certificate

GET/insurance-certificates/{id}

A certificate of insurance naming the required additional insureds. Returns one insurance certificate with its `ETag`. A insurance certificate the caller may not see returns 404.

Update an insurance certificate

PATCH/insurance-certificates/{id}

A certificate of insurance naming the required additional insureds. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete an insurance certificate

DELETE/insurance-certificates/{id}

A certificate of insurance naming the required additional insureds. Soft-deletes the insurance certificate: it moves to Trash and can be restored for its table's retention period.