plaid

(Deprecated) Get a Beacon Report Syndication

Changed on

Returns a Beacon Report Syndication for a given Beacon Report Syndication id.

post/beacon/report_syndication/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/beacon/report_syndication/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

beacon_report_syndication_idstring required

ID of the associated Beacon Report Syndication.

client_idstring

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.

secretstring

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.

Example request

{
  "beacon_report_syndication_id": "becrsn_11111111111111"
}

Response

OK

idstring required

ID of the associated Beacon Report Syndication.

beacon_user_idstring required

ID of the associated Beacon User.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Example response

{
  "id": "becrsn_11111111111111",
  "beacon_user_id": "becusr_42cF1MNo42r9Xj",
  "report": {
    "id": "becrpt_11111111111111",
    "created_at": "2020-07-24T03:26:02Z",
    "fraud_date": "1990-05-29",
    "event_date": "1990-05-29"
  },
  "analysis": {
    "address": "match",
    "date_of_birth": "match",
    "email_address": "match",
    "name": "match",
    "id_number": "match",
    "ip_address": "match",
    "phone_number": "match",
    "depository_accounts": [
      {
        "account_mask": "4000",
        "routing_number": "021000021",
        "match_status": "match"
      }
    ]
  }
}

Changes