Saltar al contenido

Get an insurance certificate insured

Módulo Vendors

GET/insurance-certificate-insureds/{id}insuranceCertificateInsureds.get

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). Returns one insurance certificate insured with its `ETag`. A insurance certificate insured the caller may not see returns 404.

  • Requiere la capacidad vendors.vendor.read.
  • Alcances de OAuth: vendors.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

insuranceCertificateInsureds.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the insurance certificate insured.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: InsuranceCertificateInsured

insuranceCertificateInsureds.get: InsuranceCertificateInsured
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the insurance certificate insured.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row.
certificate_idstring (uuid)SíIdentifier of the certificate naming the party.
insured_namestringSíParty named, as printed.Restricciones: length 1 to 200
endorsement_kind"Additional Insured" | "Primary and Noncontributory" | "Waiver of Subrogation"SíEndorsement: 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"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/insurance-certificate-insureds/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.insuranceCertificateInsureds.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.insurance_certificate_insureds.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos insurance-certificate-insureds get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f