--- title: "(Deprecated) Get a Beacon Report Syndication" method: POST path: "/beacon/report_syndication/get" tags: ["plaid"] deprecated: true --- # (Deprecated) Get a Beacon Report Syndication `POST /beacon/report_syndication/get` > **Deprecated.** Returns a Beacon Report Syndication for a given Beacon Report Syndication id. ## Request body - BeaconReportSyndicationGetRequest — Request input for getting a Beacon Report Syndication - `beacon_report_syndication_id` string, required — ID of the associated Beacon Report Syndication. - `client_id` string — 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. - `secret` string — 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. ## Response `200` OK - BeaconReportSyndicationGetResponse — A Beacon Report Syndication represents a Beacon Report created either by your organization or another Beacon customer that matches a specific Beacon User you've created. The `analysis` field in the response indicates which fields matched between the originally reported Beacon User and the Beacon User that the report was syndicated to. The `report` field in the response contains a subset of information from the original report. - `id` string, required — ID of the associated Beacon Report Syndication. - `beacon_user_id` string, required — ID of the associated Beacon User. - `report` BeaconReportSyndicationOriginalReport, required — 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. - `id` string, nullable, required — ID of the associated Beacon Report. - `created_at` string, 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_date` string, date, nullable, required — A date in the format YYYY-MM-DD (RFC 3339 Section 5.6). - `event_date` string, date, required — A date in the format YYYY-MM-DD (RFC 3339 Section 5.6). - `analysis` BeaconReportSyndicationAnalysis, required — Analysis of which fields matched between the originally reported Beacon User and the Beacon User that the report was syndicated to. - `address` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `date_of_birth` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `email_address` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `name` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `id_number` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `ip_address` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `phone_number` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `depository_accounts` BeaconSyndicatedReportDepositoryAccountMatchAnalysis[], required - `account_mask` string, required — The last 2-4 numeric characters of this account's account number. - `routing_number` string, required — The routing number of the account. - `match_status` 'match' | 'partial_match' | 'no_match' | 'no_data', required — An enum indicating the match type between two Beacon Users. `match` indicates that the provided input data was a strong match against the other Beacon User. `partial_match` indicates the data approximately matched the other Beacon User. For example, "Knope" vs. "Knope-Wyatt" for last name. `no_match` indicates that Plaid was able to compare this field against the other Beacon User and it did not match the provided input data. `no_data` indicates that Plaid was unable to compare this field against the original Beacon User because the field was not present in one of the Beacon Users. - `request_id` string, required — A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. --- [API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/revisions/64c4514ea59b/schema)