POST /beacon/report/create

Create a fraud report for a given Beacon User.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`fraud_amount`	Object	No	The amount and currency of the fraud or attempted fraud. `fraud_amount` should be omitted to indicate an unknown fraud amount.
`fraud_amount.value`	Number	Yes	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`).
`fraud_amount.iso_currency_code`	String	Yes	An ISO-4217 currency code. Possible values: `"USD"`
`client_id`	String	No	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.
`type`	String	Yes	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. Possible values: `"synthetic"` `"first_party"` `"stolen"` `"account_takeover"` `"unknown"` `"data_breach"`
`beacon_user_id`	String	Yes	ID of the associated Beacon User.
`fraud_date`	String	Yes	A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
`secret`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.