Create an insurance certificate
Vendors module
POST/insurance-certificatesinsuranceCertificates.create
A certificate of insurance naming the required additional insureds. Creates an insurance certificate. 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: InsuranceCertificateCreate
| Field | Type | Required | Description |
|---|---|---|---|
| coverage_type | string | Yes | Coverage type.Constraints: length 1 to 300 |
| coverage_limit_minor | integer (int64) | null | No | Each occurrence limit. Integer minor units of the resource currency; null means unpriced, never zero. |
| currency_code | string | null | No | 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 | No | Where the certificate document is stored. |
{
"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"
}Response 201: 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 POST "$XOS_BASE_URL/insurance-certificates" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"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"}'const { data } = await xos.insuranceCertificates.create({
"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"
});response = xos.insurance_certificates.create({"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"})xos insurance-certificates create --data '{"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"}'