(Deprecated) Create a Beacon User

Create and scan a Beacon User against your Beacon Program, according to your program's settings.

When you submit a new user to /beacon/user/create, several checks are performed immediately:

The user's PII (provided within the user object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's "Duplicate Information Filtering" settings, the user will be returned with a status of pending_review.
The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of rejected.
Finally, the user's PII is searched against all fraud reports shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a pending_review status if your program has enabled automatic flagging based on network fraud.

Request body

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.

access_tokensAccessToken[] nullable

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_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

{
  "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_number": "1234567890",
        "routing_number": "021000021"
      }
    ]
  }
}

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.