Sign in

v1

latestOpenAPI 3.1.02026-07-22191956.7 KB
Enrollments

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.

post/groups/{groupId}/enrollments

Path parameters

groupIdstring required

Group ID, e.g. grp_8c2f41d09a3e.

Headers

Idempotency-Keystring

Any unique string (UUIDs work well). Replaying the same key within 24 hours returns the stored response instead of re-executing the request.

Request body

quoteIdstring required
startDatestring date

Defaults to the quote's planYearStartDate.

onboardingMode'hosted' | 'embedded'

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.

Example request

{
  "quoteId": "qt_5b9e2c7f10ad",
  "startDate": "2026-09-01",
  "signatory": {
    "name": "Dana Park",
    "email": "dana@acme.com",
    "title": "Head of People"
  }
}

Response

Enrollment created. The group status moves to enrolled.

idstring required
groupIdstring required
mode'test' | 'live' required
status'onboarding' | 'active' required

active once Prescience flips the company to prod.

quoteIdstring required
startDatestring date required
companyDomainstring required
companyState'sandbox' | 'prod' required
onboardingMode'hosted' | 'embedded' required

How post-enrollment onboarding runs. Stamped at creation; defaults to hosted.

nextStepsstring[] required
createdAtstring date-time required

Example response

{
  "id": "enr_3f7a92c81b40",
  "groupId": "grp_8c2f41d09a3e",
  "quoteId": "qt_5b9e2c7f10ad",
  "startDate": "2026-09-01",
  "companyDomain": "acme.com",
  "employerPortal": {
    "signinUrl": "https://www.getprescience.com/signin"
  }
}