Skip to main content
POST
Create an enrollment

Authorizations

Authorization
string
header
required

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

Idempotency-Key
string

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

Maximum string length: 255

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

Pattern: ^grp_[0-9a-f]{12}$

Body

application/json
quoteId
string
required
Example:

"qt_5b9e2c7f10ad"

signatory
object
required

The employer admin who selected the plan. On the hosted pathway, provisioned as the company's admin in the Prescience employer portal.

startDate
string<date>

Defaults to the quote's planYearStartDate.

Example:

"2026-09-01"

onboardingMode
enum<string>
default:hosted

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.

Available options:
hosted,
embedded

Response

Enrollment created. The group status moves to enrolled.

id
string
required
Example:

"enr_3f7a92c81b40"

groupId
string
required
Example:

"grp_8c2f41d09a3e"

mode
enum<string>
required
Available options:
test,
live
status
enum<string>
required

active once Prescience flips the company to prod.

Available options:
onboarding,
active
quoteId
string
required
Example:

"qt_5b9e2c7f10ad"

startDate
string<date>
required
Example:

"2026-09-01"

companyDomain
string
required
Example:

"acme.com"

companyState
enum<string>
required
Available options:
sandbox,
prod
onboardingMode
enum<string>
required

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

Available options:
hosted,
embedded
onboarding
object
required

Recomputed from the live onboarding checklist on every read.

nextSteps
string[]
required
createdAt
string<date-time>
required
employerPortal
object

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).