provider plaid POST /beacon/report/create
@utdk/plaid /beacon/report/create
Create a Beacon Report
Create a fraud report for a given Beacon User.

Try it

Authentication
Configure credentials for The Plaid API
beaconreportcreate
POST/beacon/report/create
Create a fraud report for a given Beacon User.

Input

required

ID of the associated Beacon User.

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. `unknown`: If you aren't sure who committed the fraud.

required

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).

The amount and currency of the fraud or attempted fraud. `fraud_amount` should be omitted to indicate an unknown fraud amount.

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.

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.

Configure credentials above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import plaid from '@utdk/plaid';

await plaid.beaconreportcreate()