Sample - Plaid API
POST/beacon/user/updateDeprecated

Update a Beacon User

Updates the identity data associated with a Beacon User and can add accounts for evaluation. Provide beacon_user_id and at least one field in user when changing existing identity data; use access_tokens to add accounts, with a maximum of 50 accounts total. The response preserves the user's data before and after the update as separate versions.

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

5 body fields

Request input for updating a Beacon User's identity data and optionally adding accounts for evaluation.

beacon_user_idstringrequired
ID of the associated Beacon User.
userobjectoptional
A subset of a Beacon User's data which is used to patch the existing identity data associated with a Beacon User. At least one field must be provided. If left unset or null, user data will not be patched.
access_tokensarray<AccessToken>optional
Send this array of access tokens to add accounts to this user for evaluation. This will add accounts to this Beacon User. If left null only existing accounts will be returned in response. A maximum of 50 accounts total can be added to a Beacon User.
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 updated Beacon User, including its identifier, version, status, identity data, audit trail, associated Item IDs, and request identifier.
item_idsarray<string>required
An array of Plaid Item IDs corresponding to the Accounts associated with this Beacon User.
idstringrequired
ID of the associated Beacon User.
versionintegerrequired
The `version` field begins with 1 and increments each time the user is updated.
created_atstringrequired
An ISO8601 formatted timestamp.
updated_atstringrequired
An ISO8601 formatted timestamp. This field indicates the last time the resource was modified.
statusstringrequired
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.
Allowed:rejectedpending_reviewcleared
program_idstringrequired
ID of the associated Beacon Program.
client_user_idstringrequired
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`.
userobjectrequired
A Beacon User's data and resulting analysis when checked against duplicate records and the Beacon Fraud Network.
audit_trailobjectrequired
Information about the last change made to the parent object specifying what caused the change as well as when it occurred.
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_user_id is required and must identify the Beacon User to update. Provide at least one field in user to patch identity data, and use valid date, email, phone, IP address, and nested address formats where applicable. access_tokens can add accounts, up to a maximum of 50 total.