Sample - Plaid API
POST/beacon/duplicate/getDeprecated

Get a Beacon Duplicate

Retrieves a Beacon Duplicate by its identifier. The response contains the two Beacon User revisions associated with the duplicate and an analysis of the identity fields that matched. Use the duplicate identifier to inspect the relationship between the two users.

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

3 body fields

Request input for retrieving a Beacon Duplicate.

beacon_duplicate_idstringrequired
ID of the associated Beacon Duplicate.
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 Duplicate with its identifier, the two Beacon User revisions, field-match analysis, and request identifier.
idstringrequired
ID of the associated Beacon Duplicate.
beacon_user1objectrequired
A Beacon User Revision identifies a Beacon User at some point in its revision history.
beacon_user2objectrequired
A Beacon User Revision identifies a Beacon User at some point in its revision history.
analysisobjectrequired
Analysis of which fields matched between one Beacon User and another.
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_duplicate_id is required and must identify the Beacon Duplicate to retrieve. Supply valid API credentials through the supported client and secret fields or headers.