Skip to content

Create an insurance certificate insured

Vendors module

POST/insurance-certificate-insuredsinsuranceCertificateInsureds.create

A party a certificate of insurance names, with the endorsement it grants (1130). A name appears once per endorsement on a certificate, ignoring case and spacing (409). Creates an insurance certificate insured. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability vendors.coi.write.
  • OAuth scopes: vendors.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: InsuranceCertificateInsuredCreate

insuranceCertificateInsureds.create: InsuranceCertificateInsuredCreate
FieldTypeRequiredDescription
certificate_idstring (uuid)YesIdentifier of the certificate naming the party.
insured_namestringYesParty named, as printed.Constraints: length 1 to 200
endorsement_kind"Additional Insured" | "Primary and Noncontributory" | "Waiver of Subrogation"YesEndorsement: Additional Insured, Primary and Noncontributory, or Waiver of Subrogation.
{
  "certificate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "insured_name": "Example Venue Owner LLC",
  "endorsement_kind": "Additional Insured"
}

Response 201: InsuranceCertificateInsured

insuranceCertificateInsureds.create: InsuranceCertificateInsured
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the insurance certificate insured.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row.
certificate_idstring (uuid)YesIdentifier of the certificate naming the party.
insured_namestringYesParty named, as printed.Constraints: length 1 to 200
endorsement_kind"Additional Insured" | "Primary and Noncontributory" | "Waiver of Subrogation"YesEndorsement: Additional Insured, Primary and Noncontributory, or Waiver of Subrogation.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "certificate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "insured_name": "Example Venue Owner LLC",
  "endorsement_kind": "Additional Insured"
}

Code samples

curl -X POST "$XOS_BASE_URL/insurance-certificate-insureds" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"certificate_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","insured_name":"Example Venue Owner LLC","endorsement_kind":"Additional Insured"}'
const { data } = await xos.insuranceCertificateInsureds.create({
    "certificate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "insured_name": "Example Venue Owner LLC",
    "endorsement_kind": "Additional Insured"
  });
response = xos.insurance_certificate_insureds.create({"certificate_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "insured_name": "Example Venue Owner LLC", "endorsement_kind": "Additional Insured"})
xos insurance-certificate-insureds create --data '{"certificate_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","insured_name":"Example Venue Owner LLC","endorsement_kind":"Additional Insured"}'