> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getprescience.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the employee benefits summary

> The employer's approved employee plan terms, shaped for offer letters and careers pages: plan name and dates, eligibility, network, employee contributions, deductible, out-of-pocket maximum, coinsurance, the covered-care schedule, and the disclosures to print with them. Employer plan cost is never included. Returns `404 not_found` until the group is enrolled and `409 conflict` until Prescience approves the plan terms during onboarding.



## OpenAPI

````yaml /api-reference/openapi.json get /groups/{groupId}/benefits-summary
openapi: 3.1.0
info:
  title: Prescience Partner API
  version: 1.1.0
  description: >-
    Create employer groups, submit census records, generate preliminary
    market-rate quotes, create iframe sessions, create enrollments, and read
    aggregate account data.


    Money is always integer cents. Dates are `YYYY-MM-DD`; timestamps are ISO
    8601 UTC. Final pricing, eligibility, network availability, and plan
    documents are confirmed during underwriting and onboarding. A BAA and data
    processing agreement are executed before live mode is enabled.
  contact:
    name: Prescience partner engineering
    email: partners@getprescience.com
servers:
  - url: https://www.getprescience.com/api/partner/v1
    description: >-
      Production. Test and live traffic share this host; mode comes from your
      API key.
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Connectivity and key checks.
  - name: Plans
    description: Static plan metadata.
  - name: Groups
    description: 'Employer groups: the root resource of every integration.'
  - name: Census
    description: Pre-enrollment census intake and ongoing member sync.
  - name: Quotes
    description: >-
      Preliminary quotes built from the stored census and current local
      market-plan snapshot.
  - name: Enrollments
    description: Plan selection and employer provisioning.
  - name: Account
    description: Aggregate, de-identified employer account data.
  - name: Webhooks
    description: Signed event delivery (standard-webhooks scheme).
paths:
  /groups/{groupId}/benefits-summary:
    get:
      tags:
        - Account
      summary: Get the employee benefits summary
      description: >-
        The employer's approved employee plan terms, shaped for offer letters
        and careers pages: plan name and dates, eligibility, network, employee
        contributions, deductible, out-of-pocket maximum, coinsurance, the
        covered-care schedule, and the disclosures to print with them. Employer
        plan cost is never included. Returns `404 not_found` until the group is
        enrolled and `409 conflict` until Prescience approves the plan terms
        during onboarding.
      operationId: getBenefitsSummary
      parameters:
        - $ref: '#/components/parameters/GroupId'
      responses:
        '200':
          description: Approved benefits summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BenefitsSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Plan terms are not approved yet.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: conflict
                message: >-
                  Plan terms for this employer are not approved yet. Retry after
                  onboarding finishes plan setup.
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    GroupId:
      name: groupId
      in: path
      required: true
      description: Group ID, e.g. `grp_8c2f41d09a3e`.
      schema:
        type: string
        pattern: ^grp_[0-9a-f]{12}$
      example: grp_8c2f41d09a3e
  schemas:
    BenefitsSummary:
      type: object
      properties:
        groupId:
          type: string
        revision:
          type: integer
          description: >-
            Approved plan-terms revision. Regenerate offer letters when it
            changes.
        approvedAt:
          type: string
          format: date-time
        plan:
          type: object
          properties:
            name:
              type: string
            coverageStart:
              type: string
              format: date
            coverageEnd:
              type: string
              format: date
            eligibilityRule:
              type: string
            network:
              type: string
            networkCarrier:
              type: string
              description: >-
                The network's carrier name as employees see it on their card.
                The employer self-funds the plan.
            providesMinimumEssentialCoverage:
              type:
                - boolean
                - 'null'
            meetsMinimumValue:
              type:
                - boolean
                - 'null'
        employeeMonthlyContributionCents:
          type: object
          properties:
            employeeOnly:
              type:
                - integer
                - 'null'
            employeePlusOne:
              type:
                - integer
                - 'null'
            family:
              type:
                - integer
                - 'null'
        dentalVisionMonthlyContributionCents:
          type: object
          properties:
            employeeOnly:
              type:
                - integer
                - 'null'
            employeePlusOne:
              type:
                - integer
                - 'null'
            family:
              type:
                - integer
                - 'null'
        deductibleCents:
          type: object
          properties:
            employeeOnly:
              type:
                - integer
                - 'null'
            employeePlusOne:
              type:
                - integer
                - 'null'
            family:
              type:
                - integer
                - 'null'
        outOfPocketMaximumCents:
          type: object
          properties:
            employeeOnly:
              type:
                - integer
                - 'null'
            employeePlusOne:
              type:
                - integer
                - 'null'
            family:
              type:
                - integer
                - 'null'
        coinsurancePercent:
          type:
            - number
            - 'null'
        services:
          type: array
          items:
            type: object
            properties:
              service:
                type: string
              memberCost:
                type: string
              notes:
                type: string
        disclosures:
          type: array
          items:
            type: string
          description: Print these wherever the summary appears.
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - invalid_request
            - unauthorized
            - live_mode_disabled
            - forbidden
            - not_found
            - conflict
            - rates_pending
            - quote_expired
            - market_unavailable
            - census_required
            - rate_limited
            - server_error
            - not_configured
            - email_not_allowed
            - verification_failed
          description: >-
            Stable machine-readable error code. `email_not_allowed` and
            `verification_failed` come only from the iframe's own endpoints,
            which partners do not call.
        message:
          type: string
          description: >-
            Human-readable explanation. Wording may change; branch on `error`,
            not `message`.
        details:
          type: array
          description: Present on `invalid_request`. One entry per failed field.
          items:
            type: object
            required:
              - field
              - message
            properties:
              field:
                type: string
                example: zip
              message:
                type: string
                example: zip must be a 5-digit ZIP code
              index:
                type: integer
                description: >-
                  For array payloads (census rows), the zero-based index of the
                  failing row.
                example: 7
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: >-
              Provide a valid partner API key as `Authorization: Bearer
              psk_...`.
    NotFound:
      description: >-
        No such resource in this mode. Test keys only see test resources; live
        keys only see live resources.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: not_found
            message: No group grp_8c2f41d09a3e found.
    RateLimited:
      description: Rate limit exceeded. Honor `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limited
            message: Too many requests. Please retry later.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
          example: 12
    ServerError:
      description: >-
        Something failed on our side. Safe to retry with the same
        `Idempotency-Key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: server_error
            message: Internal error. The request was not applied.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Partner API key. `psk_test_<32 hex>` for test mode, `psk_live_<32 hex>`
        for live mode. Store them in your secrets manager on issue. Live keys
        are shown once; the scoped partner portal can show an active sandbox key
        again.

````