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

# Save selected SERFF filings for import

> Register 1–100 distinct source filings as pending. Requires scope edit access, your active initialized import conversation, personal login and readable workspace Products. Restores owner-only conversation access before registration. Registration starts background import processing. A saved selection is not evidence of a completed import; read its status and filingId. If dispatch is unavailable, repeat the same request to resume it. Duplicate source identities within the organization, scope and destination do not create another item. Identical retries return existing items without resetting status; conflicting selections or a source registered by another caller return 409, rolling back the entire batch. Returns results in input order.



## OpenAPI

````yaml /openapi.json post /insurance/serff-import-items
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/serff-import-items:
    post:
      tags:
        - SERFF Imports
      summary: Save selected SERFF filings for import
      description: >-
        Register 1–100 distinct source filings as pending. Requires scope edit
        access, your active initialized import conversation, personal login and
        readable workspace Products. Restores owner-only conversation access
        before registration. Registration starts background import processing. A
        saved selection is not evidence of a completed import; read its status
        and filingId. If dispatch is unavailable, repeat the same request to
        resume it. Duplicate source identities within the organization, scope
        and destination do not create another item. Identical retries return
        existing items without resetting status; conflicting selections or a
        source registered by another caller return 409, rolling back the entire
        batch. Returns results in input order.
      operationId: registerSerffImportItems
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                scope:
                  type: string
                  pattern: ^mc:[A-Za-z0-9][A-Za-z0-9-]{0,127}$
                  description: Authorization scope UUID or stable slug prefixed with mc:.
                importSessionId:
                  type: string
                  format: uuid
                destination:
                  type: string
                  enum:
                    - beta
                    - production
                loginId:
                  type: string
                  format: uuid
                  description: >-
                    Your saved personal login for the selected destination;
                    passwords are never accepted.
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      sourceFilingId:
                        type: string
                        pattern: ^[1-9][0-9]{0,31}$
                        description: >-
                          Numeric sourceId from the selected SERFF portal, as
                          text without leading zeros.
                      trackingNumber:
                        type: string
                        maxLength: 256
                        pattern: ^(?:[A-Z]{4}-[A-Z]?\d{8,11})$/i
                        description: >-
                          Full SERFF tracking number; not state or company
                          tracking.
                      productId:
                        type: string
                        format: uuid
                        description: >-
                          Readable workspace Product ID in this scope, from the
                          managed-filings/products API.
                    required:
                      - sourceFilingId
                      - trackingNumber
                      - productId
                    additionalProperties: false
                  minItems: 1
                  maxItems: 100
              required:
                - scope
                - importSessionId
                - destination
                - loginId
                - items
              additionalProperties: false
      responses:
        '200':
          description: Registered or existing items.
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        item:
                          $ref: '#/components/schemas/V2SerffImportItem'
                        created:
                          type: boolean
                      required:
                        - item
                        - created
                      additionalProperties: false
                required:
                  - items
                additionalProperties: false
        '400':
          description: Invalid request or cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '403':
          description: >-
            An ordinary user credential and scope access are required. Login
            must be your personal account for the destination.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '404':
          description: Item or a selected reference is unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '409':
          description: >-
            Session initialization is in progress, source selections conflict,
            or the item revision changed. Read current state before retrying.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '413':
          description: Request exceeds 128 KiB.
          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. A session may have been reserved; retry the
            same request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
        '503':
          description: >-
            Selections are saved but dispatch is unavailable. Repeat the same
            request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2CodedError'
      security:
        - bearerAuth: []
components:
  schemas:
    V2SerffImportItem:
      type: object
      properties:
        id:
          type: string
          format: uuid
        scope:
          type: string
        importSessionId:
          type: string
          format: uuid
        destination:
          type: string
          enum:
            - beta
            - production
        sourceFilingId:
          type: string
        trackingNumber:
          type: string
        productId:
          type: string
          format: uuid
        loginId:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - pending
            - running
            - cancelling
            - cancelled
            - completed
            - partial
            - needs_input
            - failed
        attempt:
          type: integer
          minimum: 0
        agentSessionId:
          type: string
          nullable: true
          format: uuid
        filingId:
          type: string
          nullable: true
          format: uuid
        summary:
          type: string
          nullable: true
        revision:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - scope
        - importSessionId
        - destination
        - sourceFilingId
        - trackingNumber
        - productId
        - loginId
        - status
        - attempt
        - agentSessionId
        - filingId
        - summary
        - revision
        - createdAt
        - updatedAt
      additionalProperties: false
    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.
            businessCode:
              type: string
              description: The rater’s own refusal code, for business_rejection.
            violations:
              type: array
              items:
                type: object
                properties:
                  code:
                    type: string
                    description: Authored or built-in constraint code
                  message:
                    type: string
                    description: Authored message for the failed constraint
                  path:
                    type: string
                    description: Input path of the offending value; empty for the request
                  value:
                    nullable: true
                    description: Offending input value, size-bounded by the runtime
                  constraint:
                    type: string
                    description: The constraint the value failed, as text
                  cite:
                    type: string
                    nullable: true
                    description: >-
                      Filing citation of the constraint, when the source cites
                      one
                required:
                  - code
                  - message
                  - path
                  - value
                  - constraint
                  - cite
                additionalProperties: false
              maxItems: 256
              description: >-
                Each input constraint the submission failed, for invalid_inputs
                and business_rejection.
            violationsTruncated:
              type: boolean
              description: >-
                True when the rater reported more violations than violations
                holds.
            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.