Skip to content
XOS Developers

Delete an insurance certificate

Vendors module

DELETE/insurance-certificates/{id}insuranceCertificates.delete

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.

  • Requires the capability vendors.coi.write.
  • OAuth scopes: vendors.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

insuranceCertificates.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the insurance certificate.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/insurance-certificates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.insuranceCertificates.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.insurance_certificates.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos insurance-certificates delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f