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

# List ban safe claims

> Lists the Ban Insurance claims filed on your numbers, newest first. A claim is filed automatically when a ban is recorded on a number whose plan includes insurance; there is no request to file one.

Requires `sessions:read`. Project tokens only access resources in their own project.



## OpenAPI

````yaml api-reference/features/operate.json GET /platform/bansafe/claims
openapi: 3.0.3
info:
  title: Operate API methods
  version: 1.0.0
  description: Task-focused operate methods across supported Polymorfa connection types.
servers: []
security: []
paths:
  /platform/bansafe/claims:
    get:
      tags:
        - Bansafe
      summary: List ban safe claims
      description: >-
        Lists the Ban Insurance claims filed on your numbers, newest first. A
        claim is filed automatically when a ban is recorded on a number whose
        plan includes insurance; there is no request to file one.


        Requires `sessions:read`. Project tokens only access resources in their
        own project.
      operationId: managementListBanSafeClaims
      parameters:
        - name: projectId
          in: query
          required: false
          schema:
            type: string
          description: Identifier of the Polymorfa project that owns this resource.
        - name: session
          in: query
          required: false
          schema:
            type: string
            minLength: 1
            maxLength: 256
          description: |-
            Identifier of the connected Polymorfa session.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | String length | `1` through `256` characters |
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - filed
              - under_review
              - approved
              - denied
              - paid
              - reversed
          description: |-
            Current status of this resource or operation.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `filed` | Filed. |
            | `under_review` | Under review. |
            | `approved` | Approved. |
            | `denied` | Denied. |
            | `paid` | Paid. |
            | `reversed` | Reversed. |
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Specifies cursor for this query parameter.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: |-
            Specifies limit for this query parameter.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `1` through `100` (inclusive) |
      responses:
        '200':
          description: Success
          headers:
            X-Request-Id:
              schema:
                type: string
              description: Stable request correlation identifier.
            Polymorfa-Version:
              schema:
                type: string
              description: API version applied to this response.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/management__BanSafeClaim'
                    description: Structured data carried by this object.
                  page:
                    allOf:
                      - $ref: '#/components/schemas/management__CursorPageMetadata'
                    description: Specifies page for this schema.
                required:
                  - data
                  - page
        '400':
          $ref: '#/components/responses/management__BadRequest'
        '401':
          $ref: '#/components/responses/management__Unauthorized'
        '403':
          $ref: '#/components/responses/management__Forbidden'
        '404':
          $ref: '#/components/responses/management__NotFound'
      security:
        - management__ApiKeyAuth: []
      servers:
        - url: https://api.polymorfa.com
        - url: http://localhost:8080
          description: local dev
components:
  schemas:
    management__BanSafeClaim:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          format: uuid
          description: |-
            Identifier for this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        incidentId:
          type: string
          format: uuid
          description: |-
            Identifier for the incident.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        sessionId:
          type: string
          format: uuid
          description: |-
            Identifier of the connected Polymorfa session.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        session:
          type: string
          description: Identifier of the connected Polymorfa session.
        phoneNumber:
          type: string
          description: Phone number in international format.
        projectId:
          type: string
          format: uuid
          description: |-
            Identifier of the Polymorfa project that owns this resource.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uuid` |
        status:
          type: string
          enum:
            - filed
            - under_review
            - approved
            - denied
            - paid
            - reversed
          description: |-
            Current status of this resource or operation.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `filed` | Filed. |
            | `under_review` | Under review. |
            | `approved` | Approved. |
            | `denied` | Denied. |
            | `paid` | Paid. |
            | `reversed` | Reversed. |
        verdict:
          type: string
          enum:
            - other_device
            - customer_conduct
            - shared_network
            - ours
            - inconclusive
          description: |-
            Specifies verdict for this management ban safe claim.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `other_device` | Other device. |
            | `customer_conduct` | Customer conduct. |
            | `shared_network` | Shared network. |
            | `ours` | Ours. |
            | `inconclusive` | Inconclusive. |
        windowStart:
          type: string
          format: date-time
          description: |-
            Specifies window start for this management ban safe claim.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        windowEnd:
          type: string
          format: date-time
          description: |-
            Specifies window end for this management ban safe claim.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        measuredCents:
          type: integer
          minimum: 0
          description: |-
            Credits this number consumed inside the window, in cents.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        capCents:
          type: integer
          minimum: 0
          description: |-
            The most a claim on this number's plan can return, in cents.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        amountCents:
          type: integer
          minimum: 0
          description: |-
            What this claim returns, in cents.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        evidence:
          allOf:
            - $ref: '#/components/schemas/management__BanSafeClaimEvidence'
          description: Specifies evidence for this management ban safe claim.
        summary:
          type: string
          description: Specifies summary for this management ban safe claim.
        reason:
          type: string
          description: Reason for the reported state or outcome.
        decidedAt:
          type: string
          format: date-time
          nullable: true
          description: |-
            Timestamp for decided at.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string`; Format: `date-time` |
            | Alternative 2 | `null` |

            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        paidAt:
          type: string
          format: date-time
          nullable: true
          description: |-
            Timestamp for paid at.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string`; Format: `date-time` |
            | Alternative 2 | `null` |

            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
        createdAt:
          type: string
          format: date-time
          description: |-
            ISO 8601 timestamp when this resource was created.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `date-time` |
      required:
        - id
        - incidentId
        - sessionId
        - session
        - phoneNumber
        - projectId
        - status
        - verdict
        - windowStart
        - windowEnd
        - measuredCents
        - capCents
        - amountCents
        - evidence
        - summary
        - reason
        - decidedAt
        - paidAt
        - createdAt
    management__CursorPageMetadata:
      type: object
      additionalProperties: false
      properties:
        nextCursor:
          type: string
          nullable: true
          description: |-
            Specifies next cursor for this management cursor page metadata.

            <!-- polymorfa-input-table -->
            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        hasMore:
          type: boolean
          description: Whether more.
      required:
        - nextCursor
        - hasMore
    management__BanSafeClaimEvidence:
      type: object
      additionalProperties: false
      description: >-
        Counts behind the attribution. Never a recipient, a message, or a device
        model.
      properties:
        attributionRuleVersion:
          type: integer
          minimum: 1
          nullable: true
          description: >-
            Attribution rules used when the claim was filed. Null for claims
            filed before rule versioning.


            <!-- polymorfa-input-table -->

            **Accepted alternatives**

            | Alternative | Accepted input |

            | --- | --- |

            | Alternative 1 | Type: `integer`; Numeric value: `1` or greater |

            | Alternative 2 | `null` |


            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `1` or greater |
        windowDays:
          type: integer
          minimum: 1
          description: |-
            Specifies window days for this management ban safe claim evidence.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `1` or greater |
        deviceEvidence:
          type: boolean
          description: Whether ban insurance evidence collection is on for the project.
        otherDevices:
          type: integer
          minimum: 0
          description: |-
            Specifies other devices for this management ban safe claim evidence.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
        restrictedInWindow:
          type: boolean
          description: >-
            Whether Polymorfa was restricting this number's sending inside the
            window.
        criticalFindingDays:
          type: integer
          minimum: 0
          description: >-
            Days one safety check stayed at its most serious level inside the
            window.


            <!-- polymorfa-input-table -->

            **Value constraints**

            | Constraint | Accepted input |

            | --- | --- |

            | Numeric value | `0` or greater |
        sharedConnection:
          type: boolean
          description: >-
            Whether this number shared its connection with numbers that were
            being restricted.
        measuredHours:
          type: integer
          minimum: 0
          description: |-
            Hours of measured activity Polymorfa holds for the window.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Numeric value | `0` or greater |
      required:
        - attributionRuleVersion
        - windowDays
        - deviceEvidence
        - otherDevices
        - restrictedInWindow
        - criticalFindingDays
        - sharedConnection
        - measuredHours
    management__ErrorEnvelope:
      type: object
      required:
        - error
        - data
        - docs
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - param
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - conflict_error
                - rate_limit_error
                - api_error
                - upstream_error
              description: |-
                Type discriminator for this object.

                <!-- polymorfa-input-table -->
                **Allowed values**
                | Value | Meaning |
                | --- | --- |
                | `invalid_request_error` | Invalid request error. |
                | `authentication_error` | Authentication error. |
                | `permission_error` | Permission error. |
                | `conflict_error` | Conflict error. |
                | `rate_limit_error` | Rate limit error. |
                | `api_error` | Api error. |
                | `upstream_error` | Upstream error. |
            code:
              type: string
              description: Stable failure code. Use this value for programmatic handling.
            message:
              type: string
              description: Safe explanation of the failure.
            param:
              type: string
              nullable: true
              description: |-
                Invalid request field, or null when no field applies.

                <!-- polymorfa-input-table -->
                **Accepted alternatives**
                | Alternative | Accepted input |
                | --- | --- |
                | Alternative 1 | Type: `string` |
                | Alternative 2 | `null` |
          description: Error details returned when the operation fails.
        data:
          type: string
          nullable: true
          enum:
            - null
          description: |-
            Always null for a failed request.

            <!-- polymorfa-input-table -->
            **Allowed values**
            | Value | Meaning |
            | --- | --- |
            | `null` | Null. |

            **Accepted alternatives**
            | Alternative | Accepted input |
            | --- | --- |
            | Alternative 1 | Type: `string` |
            | Alternative 2 | `null` |
        docs:
          type: string
          format: uri
          description: |-
            Documentation link to this failure code.

            <!-- polymorfa-input-table -->
            **Value constraints**
            | Constraint | Accepted input |
            | --- | --- |
            | Format | `uri` |
  responses:
    management__BadRequest:
      description: A path, query, or request-body value did not pass validation.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Unauthorized:
      description: Missing/invalid credential for this audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__Forbidden:
      description: Authenticated but lacks the required scope/role/audience.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
    management__NotFound:
      description: >-
        The requested resource was not found inside the authenticated
        organization or project scope.
      headers:
        X-Request-Id:
          schema:
            type: string
          description: Stable request correlation identifier.
        Polymorfa-Version:
          schema:
            type: string
          description: API version applied to this response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/management__ErrorEnvelope'
  securitySchemes:
    management__ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Polymorfa server credential: a scoped pmfa_ organization key, or a
        pmfa_pt_ project token on project- and session-bound operations inside
        its exact authenticated project. Keys may be personal or service-account
        owned. Both enforce selected action scopes; organization keys can
        address team resources and every project in the organization. Listener
        and browser client credentials are rejected.

````