Sample - Plaid API
POST/beacon/report/getDeprecated

Get a Beacon Report

Retrieves a Beacon Report by its identifier. Supply beacon_report_id to select the fraud report to retrieve. This operation is deprecated.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 body fields

Request identifying the Beacon Report to retrieve.

beacon_report_idstringrequired
ID of the associated Beacon Report.
client_idstringoptional
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.
secretstringoptional
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.

1 status code
200Returns the Beacon Report with its identifier, associated Beacon User, fraud type, dates, amount, audit trail, and request identifier.
idstringrequired
ID of the associated Beacon Report.
beacon_user_idstringrequired
ID of the associated Beacon User.
created_atstringrequired
An ISO8601 formatted timestamp.
typestringrequired
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.
Allowed:first_partystolensyntheticaccount_takeoverdata_breachunknown
fraud_datestringrequired
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
event_datestringrequired
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
fraud_amountobjectrequired
The amount and currency of the fraud or attempted fraud. `fraud_amount` should be omitted to indicate an unknown fraud amount.
audit_trailobjectrequired
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

beacon_report_id is required and must identify the Beacon Report to retrieve. Supply valid API credentials through the supported client and secret fields or headers.