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

# Authorize and start SERFF staging

> The signed-in human filing owner enables their personal login for this Captain session and queues draft staging. One personal login is supported per destination (production or beta). The choice persists across clarification turns and later passes; there is no expiry or completion endpoint. Agents cannot initiate this authorization. Retry an uncertain delivery with the same requestId and choices; a deliberate new pass needs a new requestId. Changing the login or destination ends the previous browser first. Returns acceptance, not evidence of a staged draft. Never submits or pays.



## OpenAPI

````yaml /openapi.json post /insurance/managed-filings/{filingId}/staging
openapi: 3.0.3
info:
  title: Effective API
  version: 2.0.0
  description: The public Effective REST API. Authenticate using an Effective API key.
servers:
  - url: https://api.canary.effectiveai.app/api/v2
    description: Canary
security:
  - bearerAuth: []
paths:
  /insurance/managed-filings/{filingId}/staging:
    post:
      tags:
        - Managed Filings
      summary: Authorize and start SERFF staging
      description: >-
        The signed-in human filing owner enables their personal login for this
        Captain session and queues draft staging. One personal login is
        supported per destination (production or beta). The choice persists
        across clarification turns and later passes; there is no expiry or
        completion endpoint. Agents cannot initiate this authorization. Retry an
        uncertain delivery with the same requestId and choices; a deliberate new
        pass needs a new requestId. Changing the login or destination ends the
        previous browser first. Returns acceptance, not evidence of a staged
        draft. Never submits or pays.
      operationId: startManagedFilingStaging
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: filingId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                requestId:
                  type: string
                  format: uuid
                destination:
                  type: string
                  enum:
                    - production
                    - beta
                loginId:
                  type: string
                  format: uuid
              required:
                - requestId
                - destination
              additionalProperties: false
      responses:
        '202':
          description: Staging authorized and queued.
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    type: string
                  sessionUrl:
                    type: string
                    format: uri
                  requestId:
                    type: string
                    format: uuid
                required:
                  - sessionId
                  - sessionUrl
                  - requestId
                additionalProperties: false
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            The filing owner must authorize staging using their signed-in
            workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Filing not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            A personal login for the selected SERFF destination is required, or
            staging authorization changed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '415':
          description: Content-Type must be application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: Staging unavailable. Retry to resume the saved request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2CodedError:
      allOf:
        - $ref: '#/components/schemas/V2Error'
        - type: object
          properties:
            code:
              type: string
              minLength: 1
              description: Stable error code. Clients must tolerate unknown future codes.
            details:
              type: array
              items:
                type: object
                properties:
                  location:
                    type: string
                    enum:
                      - path
                      - query
                      - header
                      - body
                  path:
                    type: array
                    items:
                      type: string
                      maxLength: 64
                    maxItems: 12
                  code:
                    type: string
                    enum:
                      - required
                      - invalid_type
                      - invalid_value
                      - unknown_field
                  message:
                    type: string
                    minLength: 1
                    maxLength: 200
                required:
                  - location
                  - path
                  - code
                  - message
              minItems: 1
              maxItems: 20
              description: Bounded safe validation issues; may omit some invalid fields.
            requestId:
              type: string
              minLength: 1
              maxLength: 128
              description: >-
                Existing server correlation for this HTTP attempt, when
                available.
            dataset:
              type: string
              enum:
                - naic
                - osha
              description: Dataset needed for dataset_not_enabled.
            accessUrl:
              type: string
              nullable: true
              format: uri
              description: >-
                Where to add the product to your account, for
                product_access_required.
          required:
            - code
    V2Error:
      type: object
      properties:
        error:
          type: string
          minLength: 1
          description: Human-readable explanation of the failure.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Effective API key. Send Authorization: Bearer sk-eai-...'

````

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