Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB
plaid

(Deprecated) Get a Beacon User

Fetch a Beacon User.

The Beacon User is returned with all of their associated information and a status based on the Beacon Network duplicate record and fraud checks.

post/beacon/user/get

Request body

beacon_user_idstring required

ID of the associated Beacon User.

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_user_id": "becusr_42cF1MNo42r9Xj"
}

Response

OK

item_idsstring[] required

An array of Plaid Item IDs corresponding to the Accounts associated with this Beacon User.

idstring required

ID of the associated Beacon User.

versioninteger required

The version field begins with 1 and increments each time the user is updated.

created_atstring date-time required

An ISO8601 formatted timestamp.

updated_atstring date-time required

An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.

status'rejected' | 'pending_review' | 'cleared' required

A status of a Beacon User.

rejected: The Beacon User has been rejected for fraud. Users can be automatically or manually rejected.

pending_review: The Beacon User has been marked for review.

cleared: The Beacon User has been cleared of fraud.

program_idstring required

ID of the associated Beacon Program.

client_user_idstring required

A unique ID that identifies the end user in your system. Either a user_id or the client_user_id must be provided. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the /link/token/create client_user_id to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

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

{
  "item_ids": [
    "515cd85321d3649aecddc015"
  ],
  "id": "becusr_42cF1MNo42r9Xj",
  "version": 1,
  "created_at": "2020-07-24T03:26:02Z",
  "updated_at": "2020-07-24T03:26:02Z",
  "status": "cleared",
  "program_id": "becprg_11111111111111",
  "client_user_id": "your-db-id-3b24110",
  "user": {
    "date_of_birth": "1990-05-29",
    "name": {
      "given_name": "Leslie",
      "family_name": "Knope"
    },
    "address": {
      "street": "123 Main St.",
      "street2": "Unit 42",
      "city": "Pawnee",
      "region": "IN",
      "postal_code": "46001",
      "country": "US"
    },
    "email_address": "user@example.com",
    "phone_number": "+19876543212",
    "id_number": {
      "value": "123456789",
      "type": "us_ssn"
    },
    "ip_address": "192.0.2.42",
    "depository_accounts": [
      {
        "account_mask": "4000",
        "routing_number": "021000021",
        "added_at": "2020-07-24T03:26:02Z"
      }
    ]
  },
  "audit_trail": {
    "dashboard_user_id": "54350110fedcbaf01234ffee",
    "timestamp": "2020-07-24T03:26:02Z"
  }
}