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

# List fraud events

> What fraud protection did, newest first: the checkouts it refused and why, and every change to the blacklist and its settings. `meta.counts` says how many events of each reason the same filters match.

Needs the `fraud.read` permission (Read Fraud Protection).



## OpenAPI

````yaml /api-reference/openapi.json get /stores/{storeId}/fraud-events
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/fraud-events:
    get:
      tags:
        - Fraud protection
      summary: List fraud events
      description: >-
        What fraud protection did, newest first: the checkouts it refused and
        why, and every change to the blacklist and its settings. `meta.counts`
        says how many events of each reason the same filters match.


        Needs the `fraud.read` permission (Read Fraud Protection).
      operationId: fraudEvents.list
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Which page of the list. The first is 1.
          schema:
            type: integer
            default: 1
        - name: perPage
          in: query
          required: false
          description: How many a page holds.
          schema:
            type: integer
            default: 20
        - name: reason
          in: query
          required: false
          description: >-
            Only events of this reason. `changes` is every change to the rules
            and settings.
          schema:
            type: string
            enum:
              - blacklist
              - vpn
              - country
              - unpaid_limit
              - dispute
              - refund
              - changes
        - name: search
          in: query
          required: false
          description: Part of an email address, an IP address or a rule's value.
          schema:
            type: string
        - name: range
          in: query
          required: false
          description: Only events in this period.
          schema:
            type: string
            enum:
              - today
              - yesterday
              - 7d
              - 30d
              - this_week
              - last_week
              - this_month
              - last_month
              - this_year
        - name: from
          in: query
          required: false
          description: >-
            Only events on or after this day, as `YYYY-MM-DD`. With `to`, in
            place of `range`.
          schema:
            type: string
        - name: to
          in: query
          required: false
          description: Only events on or before this day, as `YYYY-MM-DD`.
          schema:
            type: string
        - name: tz
          in: query
          required: false
          description: The time zone those days are in, as an IANA name. Left out, UTC.
          schema:
            type: string
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        reason:
                          type: string
                        orderId:
                          nullable: true
                        email:
                          type: string
                        ip:
                          type: string
                        country:
                          type: string
                        ruleId:
                          nullable: true
                        ruleType:
                          type: string
                        ruleValue:
                          type: string
                        detail:
                          type: string
                        attempts:
                          type: integer
                        by:
                          type: object
                          properties:
                            name:
                              type: string
                            email:
                              type: string
                        dateCreated:
                          type: string
                        lastAt:
                          type: string
                        network:
                          nullable: true
                  pages:
                    type: integer
                  total:
                    type: integer
                  meta:
                    type: object
                    properties:
                      counts:
                        type: object
                        properties:
                          blacklist:
                            type: integer
                          country:
                            type: integer
                          vpn:
                            type: integer
                          unpaid_limit:
                            type: integer
                          dispute:
                            type: integer
                          refund:
                            type: integer
                          rule_added:
                            type: integer
                          rule_changed:
                            type: integer
                          rule_removed:
                            type: integer
                          settings:
                            type: integer
                          all:
                            type: integer
                          changes:
                            type: integer
              example:
                success: true
                message: null
                code: null
                data:
                  - id: 6be17b99-b815-4885-b0a5-de2920ac00cd
                    reason: settings
                    orderId: null
                    email: ''
                    ip: ''
                    country: ''
                    ruleId: null
                    ruleType: ''
                    ruleValue: ''
                    detail: >-
                      Blocked buyers from North Korea. Turned on refusing VPNs
                      and proxies.
                    attempts: 1
                    by:
                      name: ''
                      email: api-docs-25aa8416@noblecheats.net
                    dateCreated: '2026-10-22T16:20:19Z'
                    lastAt: '2026-10-22T16:20:19Z'
                    network: null
                  - id: 2becde7c-cc5d-4c30-a113-b675a7193d06
                    reason: rule_changed
                    orderId: null
                    email: ''
                    ip: ''
                    country: ''
                    ruleId: 0b5c7eb9-7e60-4c2c-8a95-87f5b5fe6b71
                    ruleType: domain
                    ruleValue: mailinator.com
                    detail: Switched off the rule for email domain mailinator.com.
                    attempts: 1
                    by:
                      name: ''
                      email: api-docs-25aa8416@noblecheats.net
                    dateCreated: '2026-10-22T16:20:19Z'
                    lastAt: '2026-10-22T16:20:19Z'
                    network: null
                pages: 1
                total: 7
                meta:
                  counts:
                    blacklist: 0
                    country: 0
                    vpn: 0
                    unpaid_limit: 0
                    dispute: 0
                    refund: 1
                    rule_added: 2
                    rule_changed: 2
                    rule_removed: 1
                    settings: 1
                    all: 7
                    changes: 6
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const page = await shoply.fraudEvents.list();

            // Or every row of every page:
            for await (const row of shoply.fraudEvents.list()) {
              console.log(row);
            }
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $page = $shoply->fraudEvents->list();

            // Or every row of every page:
            foreach ($shoply->fraudEvents->list() as $row) {
                print_r($row);
            }
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            page = client.fraudEvents.list()

            # Or every row of every page:
            for row in client.fraudEvents.list():
                print(row)
components:
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

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