plaid

(Deprecated) List Beacon Report Syndications for a Beacon User

Use the /beacon/report_syndication/list endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. 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_syndication/list

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

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_report_syndications": [
    {
      "id": "becrsn_11111111111111",
      "beacon_user_id": "becusr_42cF1MNo42r9Xj",
      "report": {
        "id": "becrpt_11111111111111",
        "created_at": "2020-07-24T03:26:02Z",
        "fraud_date": "1990-05-29",
        "event_date": "1990-05-29"
      },
      "analysis": {
        "address": "match",
        "date_of_birth": "match",
        "email_address": "match",
        "name": "match",
        "id_number": "match",
        "ip_address": "match",
        "phone_number": "match",
        "depository_accounts": [
          {
            "account_mask": "4000",
            "routing_number": "021000021",
            "match_status": "match"
          }
        ]
      }
    }
  ],
  "next_cursor": "eyJkaXJlY3Rpb24iOiJuZXh0Iiwib2Zmc2V0IjoiMTU5NDM"
}

Changes

Changed in 4 of the 52 revisions of this API.415

Jul 22, 202694406d9a4d271See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
Feb 19, 20252fcba991badd1See the full diff
- ○
  added the required property beacon_report_syndications/items/beacon_user_id to the response with the 200 status
  response-required-property-added
Sep 4, 2024a2c34406c317112See the full diff
- ▲
  the response property beacon_report_syndications/items/report/fraud_date became nullable for the status 200
  response-property-became-nullable
- ●
  added the new data_breach enum value to the beacon_report_syndications/items/report/type response property for the response status 200
  response-property-enum-value-added
- ○
  added the required property beacon_report_syndications/items/analysis/depository_accounts to the response with the 200 status
  response-required-property-added
- ○
  added the required property beacon_report_syndications/items/report/event_date to the response with the 200 status
  response-required-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 21, 20245de70cc1e6ca31See the full diff
- ▲
  removed the required property beacon_report_syndications/items/analysis/depository_accounts from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property beacon_report_syndications/items/beacon_user_id from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property beacon_report_syndications/items/report/event_date from the response with the 200 status
  response-required-property-removed
- ○
  removed the data_breach enum value from the beacon_report_syndications/items/report/type response property for the response status 200
  response-property-enum-value-removed
This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history