Create a Beacon Report

POST /beacon/report/create

Create a fraud report for a given Beacon User.

Request Body

Required

Request input for creating a Beacon Report

Parameters

beacon_user_id
required, string
ID of the associated Beacon User.
type
required, string
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. unknown: If you aren’t sure who committed the fraud.
fraud_date
required, string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
fraud_amount
object
The amount and currency of the fraud or attempted fraud. fraud_amount should be omitted to indicate an unknown fraud amount.
iso_currency_code
required, string
An ISO-4217 currency code.
value
required, number
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).
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

A Beacon Report describes the type of fraud committed by a user as well as the date the fraud was committed and the total amount of money lost due to the fraud incident.

This information is used to block similar fraud attempts on your platform as well as alert other companies who screen a user with matching identity information. Other companies will not receive any new identity information, just what matched, plus information such as industry, type of fraud, and date of fraud.

You can manage your fraud reports by adding, deleting, or editing reports as you get additional information on fraudulent users.

Response Properties

id
required, string
ID of the associated Beacon Report.
beacon_user_id
required, string
ID of the associated Beacon User.
created_at
required, string
An ISO8601 formatted timestamp.
type
required, string
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
required, string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
event_date
required, string
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
fraud_amount
required, object
The amount and currency of the fraud or attempted fraud. fraud_amount should be omitted to indicate an unknown fraud amount.
iso_currency_code
required, string
An ISO-4217 currency code.
value
required, number
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
required, object
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
source
required, string
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
required, string
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
required, string
An ISO8601 formatted timestamp.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.