Get a Beacon Duplicate
POST /beacon/duplicate/get
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
Required
Request input for getting a Beacon Duplicate
Parameters
beacon_duplicate_id
ID of the associated Beacon Duplicate.
client_id
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
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
A Beacon Duplicate represents a pair of matching Beacon Users and an analysis of the fields they matched on.
Response Properties
id
ID of the associated Beacon Duplicate.
beacon_user1
A Beacon User Revision identifies a Beacon User at some point in its revision history.
id
ID of the associated Beacon User.
version
The
version field begins with 1 and increments with each subsequent revision.
beacon_user2
A Beacon User Revision identifies a Beacon User at some point in its revision history.
id
ID of the associated Beacon User.
version
The
version field begins with 1 and increments with each subsequent revision.
analysis
Analysis of which fields matched between one Beacon User and another.
address
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
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
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
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
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
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
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
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.