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

# Tell Prescience the client wants to move forward

> Records the request on the group (`move_forward`: status, time and who) and tells Prescience, which sets up enrollment on the plan of the group's current quote. The group needs a quote that is ready for its current census: before the first quote, or while an edited census is being repriced, this returns `409 quote_not_ready`. A second request changes nothing and returns the first one with `200`. The body is optional. Field names are snake_case for broker keys. HR platform partners use camelCase (`company_name` is `companyName`).



## OpenAPI

````yaml /api-reference/openapi.json post /groups/{groupId}/move-forward
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.


    Field names: broker keys send and receive snake_case (camelCase requests are
    still accepted). HR platform partners use camelCase. Where an operation
    serves both, the broker schema comes first and the camelCase one second.
  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: Brokers
    description: >-
      Quoting for brokers, the MCP server, and elections for partner-run
      enrollment.
  - name: Webhooks
    description: Signed event delivery (standard-webhooks scheme).
paths:
  /groups/{groupId}/move-forward:
    post:
      tags:
        - Groups
      summary: Tell Prescience the client wants to move forward
      description: >-
        Records the request on the group (`move_forward`: status, time and who)
        and tells Prescience, which sets up enrollment on the plan of the
        group's current quote. The group needs a quote that is ready for its
        current census: before the first quote, or while an edited census is
        being repriced, this returns `409 quote_not_ready`. A second request
        changes nothing and returns the first one with `200`. The body is
        optional. Field names are snake_case for broker keys. HR platform
        partners use camelCase (`company_name` is `companyName`).
      operationId: moveGroupForward
      parameters:
        - $ref: '#/components/parameters/GroupId'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              anyOf:
                - type: object
                  properties:
                    requested_by:
                      type: string
                      maxLength: 120
                      description: The person on your side. Defaults to your partner name.
                      example: pat@broker.example
                    note:
                      type: string
                      maxLength: 300
                - type: object
                  properties:
                    requestedBy:
                      type: string
                      maxLength: 120
                      description: The person on your side. Defaults to your partner name.
                      example: pat@broker.example
                    note:
                      type: string
                      maxLength: 300
            examples:
              broker:
                summary: Broker key
                value:
                  requested_by: pat@broker.example
              hr_platform:
                summary: HR platform key
                value:
                  requestedBy: pat@broker.example
      responses:
        '200':
          description: The group already had a request; this is the first one.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/BrokerMoveForwardResponse'
                  - $ref: '#/components/schemas/MoveForwardResponse'
        '201':
          description: The request was recorded.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/BrokerMoveForwardResponse'
                  - $ref: '#/components/schemas/MoveForwardResponse'
              examples:
                broker:
                  summary: Broker key
                  value:
                    group_id: grp_8c2f41d09a3e
                    move_forward:
                      status: requested
                      requested_at: '2026-10-03T17:04:11Z'
                      requested_by: pat@broker.example
                hr_platform:
                  summary: HR platform key
                  value:
                    groupId: grp_8c2f41d09a3e
                    moveForward:
                      status: requested
                      requestedAt: '2026-10-03T17:04:11Z'
                      requestedBy: pat@broker.example
        '400':
          description: The body is not a JSON object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: >-
            `quote_not_ready`: the group has no quote for its current census
            yet. Wait for the quote, then retry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '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:
    BrokerMoveForwardResponse:
      type: object
      required:
        - group_id
        - move_forward
      properties:
        group_id:
          type: string
          example: grp_8c2f41d09a3e
        move_forward:
          $ref: '#/components/schemas/BrokerMoveForward'
    MoveForwardResponse:
      type: object
      required:
        - groupId
        - moveForward
      properties:
        groupId:
          type: string
          example: grp_8c2f41d09a3e
        moveForward:
          $ref: '#/components/schemas/MoveForward'
    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
    BrokerMoveForward:
      type: object
      required:
        - status
        - requested_at
        - requested_by
      properties:
        status:
          type: string
          enum:
            - requested
          description: >-
            The client wants to move forward and Prescience is setting up
            enrollment.
        requested_at:
          type: string
          format: date-time
        requested_by:
          type: string
          description: >-
            The person named in the request, or your partner name for an API
            call without one.
          example: pat@broker.example
        note:
          type: string
    MoveForward:
      type: object
      required:
        - status
        - requestedAt
        - requestedBy
      properties:
        status:
          type: string
          enum:
            - requested
          description: >-
            The client wants to move forward and Prescience is setting up
            enrollment.
        requestedAt:
          type: string
          format: date-time
        requestedBy:
          type: string
          description: >-
            The person named in the request, or your partner name for an API
            call without one.
          example: pat@broker.example
        note:
          type: string
  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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.