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

# Read the risk flags of accounts

> The risk flags of each account's trader over the last `days` trading days, for reviewing a payout request: what flagged the trader, when, and your review state. One call for a whole payout queue. Consistency and other payout rules stay in the payout eligibility read. An account that is not yours comes back with `found: false`.

```bash
curl "https://api.hyperprop.com/platform/v1/organization/risk/flags?accountIds=7c9e6679-7425-40de-944b-e07fc1f90ae7" \
  -H "X-API-Key: hp_live_your_key_here"
```

**Permissions:** requires **view** access to "Traders & accounts".

**Access:** read-only and full-access API keys. Dashboard members need view access to Traders & accounts.



## OpenAPI

````yaml https://api.hyperprop.com/platform/openapi.json get /v1/organization/risk/flags
openapi: 3.0.0
info:
  title: Hyperprop Platform API
  version: 1.0.0
  description: >-
    REST API for the Hyperprop Trading Platform — provision evaluation and
    funded trading accounts, manage traders and plans, react to account
    lifecycle events via signed webhooks, and reconcile billing. Built for prop
    firms integrating from their own backend.


    Authentication, quick start, error handling, idempotency, pagination, custom
    metadata, webhooks, and the MCP connector are documented at
    https://docs.hyperprop.com.
  x-logo:
    url: https://app.hyperprop.com/logo-icon.svg
    altText: Hyperprop
    href: https://hyperprop.com
servers:
  - url: https://api.hyperprop.com/platform
    description: Production
security: []
tags:
  - name: Trading accounts
    description: Create, update, and inspect trading accounts.
  - name: Traders
    description: Look up and update the traders in your organization.
  - name: Trading plans
    description: Define the plans you sell.
  - name: Trading rules
    description: Define how accounts are evaluated.
  - name: Instruments
    description: >-
      The contracts your organization's accounts can trade, with their
      specifications.
  - name: Lockouts
    description: Pause and resume trading on an account.
  - name: Payouts
    description: Check payout eligibility and record payouts.
  - name: Purchases
    description: Purchases recorded for your organization.
  - name: Time Machine
    description: Restore accounts to an earlier trading day or instant.
  - name: Mass credit
    description: >-
      Credit back losses across many accounts after an incident, as background
      jobs you can follow, pause, export and reverse.
  - name: Webhooks
    description: Register webhook endpoints and inspect deliveries.
  - name: Events
    description: Your organization's event history, to replay or audit what happened.
  - name: Real-time streams
    description: >-
      Live events and trading data over a WebSocket, for dashboards and CRMs
      that update as things happen.
  - name: Reconciliation
    description: Balances, end-of-day snapshots, and fills for reconciliation.
  - name: Analytics
    description: Organization performance, revenue and top traders.
  - name: Risk
    description: Firm profit and loss and plan economics.
  - name: Trader insights
    description: >-
      What your traders hold right now and over time, your top traders, and the
      traders you follow.
  - name: Billing and invoices
    description: >-
      Your Hyperprop invoices, credits and billing details, with usage so far
      this month, billing cycles, forecasts and CSV exports.
  - name: Team and roles
    description: Manage dashboard access for your staff.
  - name: API keys
    description: >-
      Manage your organization's API keys: rotation, read-only keys and IP
      allowlists.
  - name: Logs and health
    description: >-
      API request logs, the audit log, integration health, and idempotency key
      recovery.
  - name: Organization profile
    description: Your organization's profile and logo.
  - name: Support
    description: Open and follow up on support tickets.
  - name: Partner access
    description: >-
      Read a trader's journal as an approved partner app, with the trader's own
      key.
paths:
  /v1/organization/risk/flags:
    get:
      tags:
        - Risk
      summary: Read the risk flags of accounts
      description: >-
        The risk flags of each account's trader over the last `days` trading
        days, for reviewing a payout request: what flagged the trader, when, and
        your review state. One call for a whole payout queue. Consistency and
        other payout rules stay in the payout eligibility read. An account that
        is not yours comes back with `found: false`.


        ```bash

        curl
        "https://api.hyperprop.com/platform/v1/organization/risk/flags?accountIds=7c9e6679-7425-40de-944b-e07fc1f90ae7"
        \
          -H "X-API-Key: hp_live_your_key_here"
        ```


        **Permissions:** requires **view** access to "Traders & accounts".


        **Access:** read-only and full-access API keys. Dashboard members need
        view access to Traders & accounts.
      operationId: getV1OrganizationRiskFlags
      parameters:
        - description: Comma-separated account ids, at most 200
          name: accountIds
          in: query
          required: true
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
          schema:
            type: string
        - description: Trading days of reports to include
          name: days
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 30
            default: 30
        - name: If-None-Match
          in: header
          required: false
          description: >-
            Optional. The `ETag` of the answer you already have. When the answer
            would be the same, the response is `304` without a body.
          example: '"Hq3mB1c0s8n2JkVbQy4Tz9uXw5E"'
          schema:
            type: string
      responses:
        '200':
          description: Flags per account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model632'
        '304':
          description: >-
            Not modified: the answer is the same as the one whose `ETag` you
            sent in `If-None-Match`. No body; keep using the answer you have.
        '400':
          description: Invalid request data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model351'
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model15'
        '403':
          description: This API key does not have admin permissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model511'
        '429':
          description: >-
            Too many requests: this endpoint allows 60 calls per minute per
            organization. Wait the number of seconds in the `Retry-After`
            header.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: Always false on errors
                    example: false
                  statusCode:
                    type: integer
                    example: 429
                  error:
                    type: string
                    example: Too Many Requests
                  message:
                    type: string
                    example: >-
                      Too many requests to this endpoint. Try again in 12
                      second(s).
                  code:
                    type: string
                    enum:
                      - RATE_LIMITED
                    example: RATE_LIMITED
                    description: >-
                      Machine-readable error code — switch on this, not on
                      message text
        '500':
          description: Internal error (`RISK_FLAGS_ERROR`)
        '503':
          description: Not available yet (`RISK_REPORTS_UNAVAILABLE`)
        '504':
          description: >-
            Gateway Timeout - The request did not complete within 25 seconds
            (`REQUEST_TIMEOUT`). Nothing was changed; retry, or narrow the
            request (for example a shorter date range).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Model633'
      security:
        - X-API-Key: []
components:
  schemas:
    Model632:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Model631'
    Model351:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 400
        error:
          type: string
          example: Bad Request
        message:
          type: string
          example: Invalid request data
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: BAD_REQUEST
    Model15:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication required
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: UNAUTHORIZED
    Model511:
      type: object
      properties:
        success:
          type: boolean
          description: Always false on errors
          example: false
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: This API key does not have admin permissions
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: INSUFFICIENT_PERMISSIONS
    Model633:
      type: object
      properties:
        statusCode:
          type: number
          example: 504
        error:
          type: string
          example: Gateway Timeout
        message:
          type: string
          example: >-
            The request did not complete within 25 seconds. Try again, or narrow
            it (for example a shorter date range).
        code:
          type: string
          description: Machine-readable error code — switch on this, not on message text
          example: REQUEST_TIMEOUT
    Model631:
      type: object
      properties:
        organizationId:
          type: string
          x-format:
            guid: true
        from:
          type: string
        to:
          type: string
        reviewStateAvailable:
          type: boolean
        coverage:
          $ref: '#/components/schemas/coverage'
        accounts:
          $ref: '#/components/schemas/Model630'
    coverage:
      type: object
      description: >-
        Which trading days the list covers; show "no findings" only when
        `complete` is true
      properties:
        from:
          type: string
          example: '2026-11-06'
        to:
          type: string
          example: '2026-11-12'
        complete:
          type: boolean
          description: >-
            True only when every closed trading day in the range has all its
            reports
          example: false
        days:
          $ref: '#/components/schemas/days'
        failedDays:
          type: integer
          example: 1
        pendingDays:
          type: integer
          example: 0
        truncatedDays:
          type: integer
          example: 0
        missingDays:
          type: integer
          example: 0
    Model630:
      type: array
      items:
        $ref: '#/components/schemas/Model629'
    days:
      type: array
      description: >-
        Closed trading days, newest first. The open day is not listed, nor
        Saturday and Sunday (no session) unless something was stored for them.
        There is no holiday calendar: holidays are computed like any weekday
      items:
        $ref: '#/components/schemas/Model624'
    Model629:
      type: object
      properties:
        accountId:
          type: string
          example: 7c9e6679-7425-40de-944b-e07fc1f90ae7
        found:
          type: boolean
          example: true
        customerId:
          type: string
          example: cust-4471
        traderId:
          type: string
          example: 2b1f0c9e-4d3a-4e5f-8a7b-6c5d4e3f2a1b
        flagged:
          type: boolean
          example: true
        counts:
          $ref: '#/components/schemas/counts'
        totalFlags:
          type: integer
        firstDay:
          type: string
        lastDay:
          type: string
        items:
          $ref: '#/components/schemas/Model626'
        level:
          $ref: '#/components/schemas/Model627'
        review:
          $ref: '#/components/schemas/review'
    Model624:
      type: object
      properties:
        tradingDay:
          type: string
          example: '2026-11-11'
        state:
          $ref: '#/components/schemas/Model623'
        expectedAt:
          type: string
          description: >-
            Pending days only: when the nightly run is due (Sunday's day: Monday
            17:10 Chicago)
          example: '2026-11-16T23:10:00.000Z'
          x-format:
            isoDate: true
        reports:
          $ref: '#/components/schemas/reports'
        truncated:
          $ref: '#/components/schemas/truncated'
    counts:
      type: object
      description: Flagging findings per report
      properties:
        hedge_pairs:
          type: integer
          example: 2
        copy_pairs:
          type: integer
          example: 0
        copy_groups:
          type: integer
          example: 1
        shared_devices:
          type: integer
          example: 1
        news_window_fills:
          type: integer
          example: 0
        self_hedges:
          type: integer
          example: 1
    Model626:
      type: array
      items:
        $ref: '#/components/schemas/Model625'
    Model627:
      type: string
      enum:
        - low
        - medium
        - high
    review:
      type: object
      properties:
        state:
          $ref: '#/components/schemas/Model628'
        savedState:
          $ref: '#/components/schemas/savedState'
        outcome:
          $ref: '#/components/schemas/outcome'
        reason:
          type: string
          example: same_household
        note:
          type: string
        updatedAt:
          type: string
          x-format:
            isoDate: true
    Model623:
      type: string
      description: >-
        `pending`: the nightly run for the day is not due yet or ran less than
        12 hours ago; `missing`: still nothing 12 hours after it was due
      example: failed
      enum:
        - ready
        - partial
        - failed
        - truncated
        - pending
        - missing
    reports:
      type: object
      description: Per report, when not all are ready
    truncated:
      type: array
      description: Reports cut at their row limit
      items:
        type: string
    Model625:
      type: object
      properties:
        report:
          $ref: '#/components/schemas/report'
        tradingDay:
          type: string
          example: '2026-11-12'
        rowId:
          type: string
          description: The finding's `id` in that day's report
          x-format:
            guid: true
        summary:
          type: string
          example: Opposite NQ positions with another trader for 412 s
        level:
          $ref: '#/components/schemas/level'
    Model628:
      type: string
      description: >-
        `new` until reviewed, and again when the trader is flagged on a later
        trading day than the review
      example: new
      enum:
        - new
        - reviewed
        - cleared
    savedState:
      type: string
      description: The state last saved, if any
      example: cleared
      enum:
        - new
        - reviewed
        - cleared
    outcome:
      type: string
      description: Outcome of the latest decision
      enum:
        - confirmed
        - innocent
        - watching
    report:
      type: string
      example: hedge_pairs
      enum:
        - hedge_pairs
        - copy_pairs
        - copy_groups
        - shared_devices
        - news_window_fills
    level:
      type: string
      example: medium
      enum:
        - low
        - medium
        - high
  securitySchemes:
    X-API-Key:
      type: apiKey
      name: X-API-Key
      in: header
      description: >-
        Organization API key (`hp_live_...`), sent in the `X-API-Key` header.
        Create, rotate and restrict keys in the dashboard or with the API keys
        endpoints; an organization can have two active keys, so you can rotate
        without downtime. A **full-access** key can call every endpoint in this
        reference. A **read-only** key can call `GET` endpoints (and create a
        trading stream token); any other request returns `403 READ_ONLY_KEY`. A
        key with an IP allowlist returns `403 IP_NOT_ALLOWED` from any other
        address. Each endpoint lists which keys can call it under **Access**.

````

## Related topics

- [Read the trader's personal risk settings for an account.](https://docs.hyperprop.com/trade-api/risk/read-the-traders-personal-risk-settings-for-an-account.md)
- [Read the risk money summary](https://docs.hyperprop.com/platform-api/risk/read-the-risk-money-summary.md)
- [Read the daily risk report of a trading day](https://docs.hyperprop.com/platform-api/risk/read-the-daily-risk-report-of-a-trading-day.md)
- [List flagged traders](https://docs.hyperprop.com/platform-api/risk/list-flagged-traders.md)
- [Set the review state of a flagged trader](https://docs.hyperprop.com/platform-api/risk/set-the-review-state-of-a-flagged-trader.md)


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