REFERENCE · ALTERNATIVES, STATE CONDITIONS, AND PROGRAMS
PUT /v1/insureds/{insured_ref}/enrollments/{program_ref}
Your attestation that the insured is covered under the program. Upsert. 404 when the program or the insured is unknown to this key; this call never creates an insured. Each change is audit-logged with who set it and when, fires enrollment.changed, and re-evaluates the insured's active engagements.
PARAMETERS
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| insured_ref | string | yes | |
| program_ref | string | yes | |
| Idempotency-Key | string | no | Optional, and the preferred way to make a retry safe. Send one on every POST and PUT; a replay returns the original response with idempotent_replay true and creates nothing new. POST /documents also accepts an idempotency_key form field as an alias; the header wins when both are sent |
| enrolled | boolean | yes | |
| effective_on | string | no | |
| ends_on | string | no | |
| source | string | no | Who attests the enrollment, e.g. gigsafe |
| external_id | string | no | Your reference for the attestation, e.g. the DocuSign envelope id |
| meta | object | no |
RESPONSE
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| enrollment_id | string | The id a rule this enrollment decided carries in fact_ids |
| program_ref | string | |
| program_name | string | |
| coverage_type | string | |
| verification | enum | attestation, master_policy. |
| insured_ref | string | |
| enrolled | boolean | |
| active | boolean | enrolled, effective_on null or on/before today, and ends_on null or on/after today |
| effective_on | string | |
| ends_on | string | |
| source | string | |
| external_id | string | |
| actor | string | Who set it (the API key's name) |
| meta | object | |
| created_at | timestamp | |
| updated_at | timestamp | |
| test | boolean |
Errors: 400, 401, 403, 404, 409, 422, 429, 500. Every error body carries error.code, error.message, and error.request_id.