---
title: "(Deprecated) List Beacon Reports for a Beacon User"
method: POST
path: "/beacon/report/list"
tags: ["plaid"]
deprecated: true
---

# (Deprecated) List Beacon Reports for a Beacon User

`POST /beacon/report/list`

> **Deprecated.**

Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.

## Request body

- BeaconReportListRequest — Request input for listing Beacon Reports
  - `beacon_user_id` string, required — ID of the associated Beacon User.
  - `cursor` string, nullable — An identifier that determines which page of results you receive.
  - `client_id` string — Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
  - `secret` string — Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

## Response `200`

OK

- BeaconReportListResponse — The response schema for `/beacon/report/list`
  - `beacon_reports` BeaconReport[], required
    - `id` string, required — ID of the associated Beacon Report.
    - `beacon_user_id` string, required — ID of the associated Beacon User.
    - `created_at` string, date-time, required — An ISO8601 formatted timestamp.
    - `type` 'first_party' | 'stolen' | 'synthetic' | 'account_takeover' | 'data_breach' | 'unknown', required — The type of Beacon Report. `first_party`: If this is the same individual as the one who submitted the KYC. `stolen`: If this is a different individual from the one who submitted the KYC. `synthetic`: If this is an individual using fabricated information. `account_takeover`: If this individual's account was compromised. `data_breach`: If this individual's data was compromised in a breach. `unknown`: If you aren't sure who committed the fraud.
    - `fraud_date` string, date, nullable, required — A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
    - `event_date` string, date, required — A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
    - `fraud_amount` FraudAmount, nullable, required — The amount and currency of the fraud or attempted fraud. `fraud_amount` should be omitted to indicate an unknown fraud amount.
      - `iso_currency_code` 'USD', required — An ISO-4217 currency code.
      - `value` number, double, required — The amount value. This value can be 0 to indicate no money was lost. Must not contain more than two digits of precision (e.g., `1.23`).
    - `audit_trail` BeaconAuditTrail, required — Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
      - `source` 'dashboard' | 'api' | 'system' | 'bulk_import', required — A type indicating what caused a resource to be changed or updated. `dashboard` - The resource was created or updated by a member of your team via the Plaid dashboard. `api` - The resource was created or updated via the Plaid API. `system` - The resource was created or updated automatically by a part of the Plaid Beacon system. For example, if another business using Plaid Beacon created a fraud report that matched one of your users, your matching user's status would automatically be updated and the audit trail source would be `system`. `bulk_import` - The resource was created or updated as part of a bulk import process. For example, if your company provided a CSV of user data as part of your initial onboarding, the audit trail source would be `bulk_import`.
      - `dashboard_user_id` string, nullable, required — ID of the associated user. To retrieve the email address or other details of the person corresponding to this ID, use `/dashboard_user/get`.
      - `timestamp` string, date-time, required — An ISO8601 formatted timestamp.
  - `next_cursor` string, nullable, required — An identifier that determines which page of results you receive.
  - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)
