> ## Documentation Index > Fetch the complete documentation index at: https://docs.withflex.com/llms.txt > Use this file to discover all available pages before exploring further. # List Reviews > Returns a list of your fraud reviews, newest-first. Use the `open` filter to focus on reviews that still need action. ## OpenAPI ````yaml /openapi.json get /v1/reviews openapi: 3.1.0 info: title: Flex API description: >- The Flex API powers HSA/FSA payment processing for healthcare commerce: checkout sessions, payment intents, subscriptions, customers, refunds, disputes, and eligibility. Authenticate with your partner API key as a Bearer token. All endpoints are scoped to your partner account, and test mode is fully supported via test API keys. version: 0.1.0 servers: - url: https://api.withflex.com security: - BearerAuth: [] tags: - name: Balance Transactions - name: Captures - name: Checkout Sessions - name: Coupons - name: Customers - name: Disputes - name: Events - name: Exports - name: Files - name: Invoices - name: Letters - name: Orders - name: Payment Intents - name: Payment Links - name: Payouts - name: Prices - name: Products - name: Promo Codes - name: Receipts - name: Refunds - name: Setup Intents - name: Shipping Rates - name: Subscriptions paths: /v1/reviews: get: tags: - Reviews summary: List Reviews description: |- Returns a list of your fraud reviews, newest-first. Use the `open` filter to focus on reviews that still need action. operationId: v1.reviews.list parameters: - in: query name: open description: >- Filter by review state. `true` returns only open reviews, `false` returns only closed. Omit to return both. schema: description: >- Filter by review state. `true` returns only open reviews, `false` returns only closed. Omit to return both. type: - boolean - 'null' style: form - in: query name: charge_id description: Filter to reviews on a specific charge. schema: description: Filter to reviews on a specific charge. examples: - fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA type: - string - 'null' style: form example: fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA - in: query name: payment_intent_id description: Filter to reviews on a specific payment intent. schema: description: Filter to reviews on a specific payment intent. examples: - fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA type: - string - 'null' style: form example: fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA - in: query name: client_reference_id description: >- Filter by `client_reference_id` (matches your own identifier on the underlying checkout session, when present). schema: description: >- Filter by `client_reference_id` (matches your own identifier on the underlying checkout session, when present). type: - string - 'null' style: form - in: query name: starting_after description: Cursor for forward pagination — review id from a previous page. schema: description: Cursor for forward pagination — review id from a previous page. examples: - frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA type: - string - 'null' style: form example: frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA - in: query name: ending_before description: Cursor for backward pagination. schema: description: Cursor for backward pagination. examples: - frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA type: - string - 'null' style: form example: frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA - in: query name: limit description: Page size, between 1 and 100. Default 20. schema: description: Page size, between 1 and 100. Default 20. examples: - 10 type: - integer - 'null' format: int32 maximum: 100 minimum: 1 style: form example: 10 responses: '200': description: An envelope wrapping a list of review objects. content: application/json: schema: $ref: '#/components/schemas/MultipleReviewsBody_for_Review' example: reviews: - review_id: frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA charge_id: fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA payment_intent_id: fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA partner_id: facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA reason: rule opened_reason: rule open: false test_mode: false client_reference_id: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA created_at: '2026-06-15T14:30:00Z' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' example: detail: - loc: - string msg: string type: string '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/HttpErrorOut' example: code: string detail: string security: - BearerAuth: - reviews:read components: schemas: MultipleReviewsBody_for_Review: description: An envelope wrapping a list of review objects. type: object required: - reviews properties: reviews: description: The list of reviews. type: array items: $ref: '#/components/schemas/Review' example: reviews: - review_id: frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA charge_id: fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA payment_intent_id: fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA partner_id: facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA reason: rule opened_reason: rule open: false test_mode: false client_reference_id: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA created_at: '2026-06-15T14:30:00Z' HttpErrorOut: title: HttpError description: The error response returned when a request cannot be completed. type: object required: - code - detail properties: code: description: A short machine-readable error code identifying the type of error. type: string detail: description: A human-readable explanation of what went wrong. type: string example: code: string detail: string HTTPValidationError: description: The error response returned when request validation fails (HTTP 422). type: object required: - detail properties: detail: description: The list of validation errors, one entry per invalid field. type: array items: $ref: '#/components/schemas/ValidationErrorItem' example: detail: - loc: - string msg: string type: string Review: description: >- A Review represents a payment flagged by fraud detection for manual review. A review stays open while the payment awaits a decision and closes once it is approved or otherwise resolved. type: object required: - created_at - open - opened_reason - partner_id - reason - review_id - test_mode properties: review_id: description: Unique identifier for the review, prefixed with `frv_`. type: string example: frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA charge_id: description: >- ID of the Charge under review, prefixed with `fch_`. `null` if the review is not associated with a specific charge. type: - string - 'null' example: fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA payment_intent_id: description: >- ID of the Payment Intent under review, prefixed with `fpi_`. `null` if the review is not associated with a specific payment intent. type: - string - 'null' example: fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA partner_id: description: >- ID of the account that owns the payment under review, prefixed with `facct_`. type: string example: facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA reason: $ref: '#/components/schemas/ReviewReason' description: >- The current reason associated with the review. Reflects why the review is open while `open` is `true`, and the outcome once it is closed. opened_reason: $ref: '#/components/schemas/ReviewOpenedReason' description: >- Reason the review was originally opened: `rule` (triggered by an automated fraud rule) or `manual` (opened by hand). closed_reason: description: >- The reason the review was closed. Omitted while the review is still open. anyOf: - $ref: '#/components/schemas/ReviewClosedReason' - type: 'null' open: description: >- Whether the review is still open. `true` while the payment is under review, `false` once it has been resolved. type: boolean example: false billing_zip: description: >- Billing ZIP/postal code provided for the payment under review. Omitted if not available. type: - string - 'null' ip_address: description: >- IP address from which the payment under review was made. Omitted if not available. type: - string - 'null' test_mode: description: >- Whether this review was created in test mode. `true` for test-mode data, `false` for live data. type: boolean example: false client_reference_id: description: >- Your own identifier for the payment under review, carried over from the originating checkout session or payment. Omitted if none was set. type: - string - 'null' example: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA created_at: $ref: '#/components/schemas/Timestamptz' description: When the review was created (ISO 8601 format). example: '2026-06-15T14:30:00Z' example: review_id: frv_01J9XR8M3K7VZ8N2YB4WJ6T0RA charge_id: fch_01J9XR8M3K7VZ8N2YB4WJ6T0RA payment_intent_id: fpi_01J9XR8M3K7VZ8N2YB4WJ6T0RA partner_id: facct_01J9XR8M3K7VZ8N2YB4WJ6T0RA reason: rule opened_reason: rule closed_reason: approved open: false test_mode: false client_reference_id: obj_01J9XR8M3K7VZ8N2YB4WJ6T0RA created_at: '2026-06-15T14:30:00Z' ValidationErrorItem: description: >- Validation errors have their own schema to provide context for invalid requests eg. mismatched types and out of bounds values. There may be any number of these per 422 UNPROCESSABLE ENTITY error. type: object required: - loc - msg - type properties: loc: description: >- The location as a [`Vec`] of [`String`]s -- often in the form `["body", "field_name"]`, `["query", "field_name"]`, etc. They may, however, be arbitarily deep. type: array items: type: string msg: description: The message accompanying the validation error item. type: string type: description: >- The type of error, often "type_error" or "value_error", but sometimes with more context like as "value_error.number.not_ge" type: string example: loc: - string msg: string type: string ReviewReason: description: Why the review is currently open or closed. type: string enum: - rule - manual - approved - refunded - refunded_as_fraud - disputed - redacted example: rule ReviewOpenedReason: description: Why the review was opened. type: string enum: - rule - manual example: rule ReviewClosedReason: description: Why the review was closed. type: string enum: - approved - disputed - redacted - refunded - refunded_as_fraud example: approved Timestamptz: description: >- A timestamp encoded as an RFC 3339 / ISO 8601 string (e.g. `2026-06-15T14:30:00Z`). type: string example: string securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: API Key description: Use a Bearer token to access this API. ````