Skip to main content
GET
/
groups
/
{groupId}
/
enrollments
/
{enrollmentId}
Get an enrollment
curl --request GET \
  --url https://www.getprescience.com/api/partner/v1/groups/{groupId}/enrollments/{enrollmentId} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://www.getprescience.com/api/partner/v1/groups/{groupId}/enrollments/{enrollmentId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://www.getprescience.com/api/partner/v1/groups/{groupId}/enrollments/{enrollmentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://www.getprescience.com/api/partner/v1/groups/{groupId}/enrollments/{enrollmentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.getprescience.com/api/partner/v1/groups/{groupId}/enrollments/{enrollmentId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://www.getprescience.com/api/partner/v1/groups/{groupId}/enrollments/{enrollmentId}")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://www.getprescience.com/api/partner/v1/groups/{groupId}/enrollments/{enrollmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "enr_3f7a92c81b40",
  "groupId": "grp_8c2f41d09a3e",
  "mode": "test",
  "status": "onboarding",
  "quoteId": "qt_5b9e2c7f10ad",
  "startDate": "2026-09-01",
  "companyDomain": "acme.com",
  "companyState": "sandbox",
  "onboardingMode": "hosted",
  "employerPortal": {
    "provisioned": true,
    "signinUrl": "https://www.getprescience.com/signin",
    "inviteSuppressed": true
  },
  "onboarding": {
    "percentComplete": 60,
    "blockingRemaining": 2
  },
  "nextSteps": [
    "Prescience onboarding call scheduled with the employer",
    "Employer completes KYB + plan setup in the Prescience portal",
    "Prescience activates the group (state -> prod)"
  ],
  "createdAt": "2026-06-12T09:14:32Z"
}
{
  "error": "unauthorized",
  "message": "Provide a valid partner API key as `Authorization: Bearer psk_...`."
}
{
  "error": "not_found",
  "message": "No group grp_8c2f41d09a3e found."
}
{
  "error": "rate_limited",
  "message": "Rate limit exceeded. Retry after 12 seconds."
}
{
  "error": "server_error",
  "message": "Internal error. The request was not applied."
}

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.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

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

Enrollment ID, e.g. enr_3f7a92c81b40.

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

Response

The enrollment with live onboarding progress.

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