Sign in

v1

latestOpenAPI 3.1.02026-07-22191956.7 KB
Enrollments

Get an enrollment

onboarding is recomputed from the live onboarding checklist on every read. When Prescience flips the company to prod, status becomes active and the group status moves to active, also announced by the group.state_changed webhook.

get/groups/{groupId}/enrollments/{enrollmentId}

Path parameters

groupIdstring required

Group ID, e.g. grp_8c2f41d09a3e.

enrollmentIdstring required

Enrollment ID, e.g. enr_3f7a92c81b40.

Response

The enrollment with live onboarding progress.

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"
  }
}