List Beacon Report Syndications for a Beacon User
POST /beacon/report_syndication/list
Use the /beacon/report_syndication/list endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the next_cursor field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the next_cursor value as the cursor parameter in the next request.
Request Body
Required
Request input for listing Beacon Report Syndications
Parameters
beacon_user_id
ID of the associated Beacon User.
cursor
An identifier that determines which page of results you receive.
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
The response schema for /beacon/report_syndication/list
Response Properties
beacon_report_syndications
id
ID of the associated Beacon Report Syndication.
beacon_user_id
ID of the associated Beacon User.
report
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
ID of the associated Beacon Report.
created_at
An ISO8601 formatted timestamp.
type
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
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
event_date
A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
analysis
Analysis of which fields matched between the originally reported Beacon User and the Beacon User that the report was syndicated to.
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.
depository_accounts
account_mask
The last 2-4 numeric characters of this accountās account number.
routing_number
The routing number of the account.
match_status
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.
next_cursor
An identifier that determines which page of results you receive.
request_id
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.