Skip to content
XOS Developers

Delete a required additional insured

Vendors module

DELETE/required-additional-insureds/{id}requiredAdditionalInsureds.delete

A party the org requires its vendors' certificates to name (1130): org-wide when project_id is null, or for vendors engaged on one project as well. app.verify_onboarding_insureds checks an engagement against them. Soft-deletes the required additional insured: 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

requiredAdditionalInsureds.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the required additional insured.

Response 204: no body.

Code samples

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