--- title: "(Deprecated) Get a Beacon Duplicate" method: POST path: "/beacon/duplicate/get" tags: ["plaid"] deprecated: true --- # (Deprecated) Get a Beacon Duplicate `POST /beacon/duplicate/get` > **Deprecated.** Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are returned for each Duplicate record in either the `beacon_user1` or `beacon_user2` response fields. The `analysis` field in the response indicates which fields matched between `beacon_user1` and `beacon_user2`. ## Request body - BeaconDuplicateGetRequest — Request input for getting a Beacon Duplicate - `beacon_duplicate_id` string, required — ID of the associated Beacon Duplicate. - `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 - BeaconDuplicateGetResponse — A Beacon Duplicate represents a pair of matching Beacon Users and an analysis of the fields they matched on. - `id` string, required — ID of the associated Beacon Duplicate. - `beacon_user1` BeaconUserRevision, required — A Beacon User Revision identifies a Beacon User at some point in its revision history. - `id` string, required — ID of the associated Beacon User. - `version` integer, required — The `version` field begins with 1 and increments with each subsequent revision. - `beacon_user2` BeaconUserRevision, required — A Beacon User Revision identifies a Beacon User at some point in its revision history. - `id` string, required — ID of the associated Beacon User. - `version` integer, required — The `version` field begins with 1 and increments with each subsequent revision. - `analysis` BeaconMatchSummaryAnalysis, required — Analysis of which fields matched between one Beacon User and another. - `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. - `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/versions/64c4514ea59b/schema)