Get an insurance certificate
Vendors module
GET/insurance-certificates/{id}insuranceCertificates.get
A certificate of insurance naming the required additional insureds. Returns one insurance certificate with its `ETag`. A insurance certificate the caller may not see returns 404.
- Requires the capability vendors.vendor.read.
- OAuth scopes: vendors.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the insurance certificate. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: InsuranceCertificate
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the insurance certificate. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| coverage_type | string | Yes | Coverage type.Constraints: length 1 to 300 |
| coverage_limit_minor | integer (int64) | null | Yes | Each occurrence limit. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | Yes | ISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$ |
| valid_to | string (date) | Yes | Expiry. |
| vendor_id | string (uuid) | Yes | Identifier of the insured vendor. |
| insurer | string | Yes | Insurance carrier.Constraints: length 1 to 300 |
| policy_identifier | string | Yes | Policy number.Constraints: length 1 to 100 |
| valid_from | string (date) | Yes | First day of coverage. |
| document_uri | string (uri) | null | Yes | Where the certificate document is stored. |
{
"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",
"coverage_type": "General Liability",
"coverage_limit_minor": 100000000,
"currency_code": "USD",
"valid_to": "2026-10-08",
"vendor_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"insurer": "Example Mutual",
"policy_identifier": "GL-2027-0042",
"valid_from": "2026-10-08",
"document_uri": "https://northwindlive.example/files/site-plan.pdf"
}Code samples
curl -X GET "$XOS_BASE_URL/insurance-certificates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.insuranceCertificates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.insurance_certificates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos insurance-certificates get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f