plaid

(Deprecated) Review a Beacon User

Update the status of a Beacon User.

When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check:

Whether there are any associated Beacon Reports connected to the Beacon User, and
Whether there are any confirmed Beacon Report Syndications connected to the Beacon User.

When updating a Beacon User's status to rejected, we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to cleared, we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to cleared. There are no restrictions on updating a Beacon User's status to pending_review.

If these conditions are not met, the request will be rejected with an error explaining the issue.

post/beacon/user/review

Request body

beacon_user_idstring required

ID of the associated Beacon User.

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.

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",
  "status": "cleared"
}

Response

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"
  }
}

Changes

Changed in 6 of the 52 revisions of this API.616

Jul 22, 202694406d9a4d271See the full diff
- ○
  endpoint deprecated
  endpoint-deprecated
Jun 25, 202680d23bfdc2e51See the full diff
- ●
  added the new in_epic enum value to the user/id_number/type response property for the response status 200
  response-property-enum-value-added
Sep 4, 2024a2c34406c3171See the full diff
- ○
  added the required property user/depository_accounts to the response with the 200 status
  response-required-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 18, 2024be701ec9316121See the full diff
- ▲
  the client_user_id response property's minLength was decreased from 1 to 0 for the response status 200
  response-property-min-length-decreased
- ▲
  the user/address/country response property's minLength was decreased from 2 to 0 for the response status 200
  response-property-min-length-decreased
- ○
  added the required property item_ids to the response with the 200 status
  response-required-property-added
Mar 11, 2024ec7541420dd22See the full diff
- ○
  added the required property audit_trail/timestamp to the response with the 200 status
  response-required-property-added
- ○
  added the required property version to the response with the 200 status
  response-required-property-added
Feb 21, 20245de70cc1e6ca41See the full diff
- ▲
  removed the required property audit_trail/timestamp from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property item_ids from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property user/depository_accounts from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property version from the response with the 200 status
  response-required-property-removed
- ○
  removed the in_epic enum value from the user/id_number/type response property for the response status 200
  response-property-enum-value-removed
This revision also has 699 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history