Sample - Plaid API
POST/beacon/report_syndication/getDeprecated

Get a Beacon Report Syndication

Retrieves a Beacon Report Syndication by its identifier. Supply beacon_report_syndication_id to select the syndication to retrieve, including the original report details and matching analysis. This operation is deprecated.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

3 body fields

Request identifying the Beacon Report Syndication to retrieve.

beacon_report_syndication_idstringrequired
ID of the associated Beacon Report Syndication.
client_idstringoptional
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.
secretstringoptional
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.

1 status code
200Returns the Beacon Report Syndication with its associated Beacon User, original report details, matching analysis, and request identifier.
idstringrequired
ID of the associated Beacon Report Syndication.
beacon_user_idstringrequired
ID of the associated Beacon User.
reportobjectrequired
A subset of information from a Beacon Report that has been syndicated to a matching Beacon User in your program. The `id` field in the response is the ID of the original report that was syndicated. If the original report was created by your organization, the field will be filled with the ID of the report. Otherwise, the field will be `null` indicating that the original report was created by another Beacon customer.
analysisobjectrequired
Analysis of which fields matched between the originally reported Beacon User and the Beacon User that the report was syndicated to.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

beacon_report_syndication_id is required and must identify the Beacon Report Syndication to retrieve. Supply valid API credentials through the supported client and secret fields or headers.