Create an enrollment
Locks the employer’s plan selection against a quote. Requires an unexpired ready quote and an enrollment-ready census: every active member needs firstName, lastName, and email (failures come back as invalid_request with per-member details). Prescience provisions the company (state sandbox), materializes the census, and starts the onboarding pipeline. On the hosted pathway (default) the signatory is also provisioned as an employer portal admin and receives a set-password invite; in test mode the invite email is suppressed (employerPortal.inviteSuppressed: true). Fires the enrollment.created webhook.
Authorizations
Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Keys are stored hashed and cannot be recovered; store them in your secrets manager on issue.
Headers
Any unique string (UUIDs work well). Replaying the same key within 24 hours returns the stored response instead of re-executing the request.
255Path Parameters
Group ID, e.g. grp_8c2f41d09a3e.
^grp_[0-9a-f]{12}$Body
"qt_5b9e2c7f10ad"
The employer admin who selected the plan. On the hosted pathway, provisioned as the company's admin in the Prescience employer portal.
Defaults to the quote's planYearStartDate.
"2026-09-01"
How post-enrollment onboarding runs. hosted (default): Prescience provisions the signatory as an employer portal admin and runs onboarding, KYB, banking, and plan setup in the Prescience employer portal; track progress via GET /groups/{groupId}/enrollments/{enrollmentId} or webhooks. embedded: onboarding rendered in your own UI when enabled for the integration.
hosted, embedded Response
Enrollment created. The group status moves to enrolled.
"enr_3f7a92c81b40"
"grp_8c2f41d09a3e"
test, live active once Prescience flips the company to prod.
onboarding, active "qt_5b9e2c7f10ad"
"2026-09-01"
"acme.com"
sandbox, prod How post-enrollment onboarding runs. Stamped at creation; defaults to hosted.
hosted, embedded Recomputed from the live onboarding checklist on every read.
Provisioning summary for the signatory's employer portal account. Present whenever the signatory was provisioned as an employer portal admin (always on the hosted pathway).