Get a required additional insured

Módulo Vendors

GET/required-additional-insureds/{id}requiredAdditionalInsureds.get

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. Returns one required additional insured with its `ETag`. A required additional 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

requiredAdditionalInsureds.get: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the required additional insured.
fields	Fields	No	Sparse 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: RequiredAdditionalInsured

requiredAdditionalInsureds.get: RequiredAdditionalInsured
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the required additional insured.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row.
project_id	string (uuid) \| null	Sí	Identifier of the project the requirement adds to; null for every project.
insured_name	string	Sí	Party that must be named.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",
  "project_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/required-additional-insureds/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.requiredAdditionalInsureds.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.required_additional_insureds.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos required-additional-insureds get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f