Sample - Plaid API
POST/beacon/user/createDeprecated

Create a Beacon User

Creates and scans a Beacon User against the configured Beacon Program. Supply the user's identifying information and, when applicable, linked access tokens or depository accounts to improve duplicate and fraud detection. This operation is deprecated.

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

6 body fields

Beacon User data and optional account information for fraud and duplicate scanning.

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 which is used to check against duplicate records and the Beacon Fraud Network. In order to create a Beacon User, in addition to the `name`, _either_ the `date_of_birth` _or_ the `depository_accounts` field must be provided.
access_tokensarray<AccessToken>optional
Send this array of access tokens to link accounts to the Beacon User and have them evaluated for Account Insights. A maximum of 50 accounts total can be added to a single 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 created Beacon User with its identifier, version, timestamps, fraud-screening status, associated Item identifiers, audit trail, 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

program_id, client_user_id, and user are required, and user.name must include both given and family names. The user must include a date of birth or depository accounts, and nested address and account fields must satisfy their required-field constraints. email_address must be a valid RFC-compliant email address and phone_number must use E.164 format.