plaid

(Deprecated) List Beacon Reports for a Beacon User

Changed on

Use the /beacon/report/list endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the next_cursor field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the next_cursor value as the cursor parameter in the next request.

post/beacon/report/list

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beacon/report/list
  • 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_user_idstring required

ID of the associated Beacon User.

cursorstring nullable

An identifier that determines which page of results you receive.

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_user_id": "becusr_42cF1MNo42r9Xj",
  "cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Response

OK

next_cursorstring nullable required

An identifier that determines which page of results you receive.

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

{
  "beacon_reports": [
    {
      "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"
      }
    }
  ],
  "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

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