plaid

(Deprecated) Get a Beacon Report

Changed on

Returns a Beacon Report for a given Beacon Report ID.

post/beacon/report/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beacon/report/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

beacon_report_idstring required

ID of the associated Beacon Report.

client_idstring

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.

secretstring

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.

Example request

{
  "beacon_report_id": "becrpt_11111111111111"
}

Response

OK

idstring required

ID of the associated Beacon Report.

beacon_user_idstring required

ID of the associated Beacon User.

created_atstring 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_datestring date nullable required

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

event_datestring date required

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

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Example response

{
  "id": "becrpt_11111111111111",
  "beacon_user_id": "becusr_42cF1MNo42r9Xj",
  "created_at": "2020-07-24T03:26:02Z",
  "fraud_date": "1990-05-29",
  "event_date": "1990-05-29",
  "fraud_amount": {
    "value": 100
  },
  "audit_trail": {
    "dashboard_user_id": "54350110fedcbaf01234ffee",
    "timestamp": "2020-07-24T03:26:02Z"
  }
}

Changes

  • 94406d9a4d27Revision changes
    • info

      endpoint deprecated

  • a2c34406c317Revision changes
    • breaking

      the response property became nullable for the status

    • warning

      added the new data_breach enum value to the response property for the response status

    • info

      added the required property to the response with the status