Pricing Templates
Log in Sign up
Integrations / Plaid / ...

POST /beacon/user/create

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:

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
access_tokens[] Array No

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_id String No

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.
user Object Yes

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.
user.date_of_birth String No

A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
user.name Object Yes

The full name for a given Beacon User.
user.name.family_name String Yes

A string with at least one non-whitespace character, with a max length of 100 characters.
user.name.given_name String Yes

A string with at least one non-whitespace character, with a max length of 100 characters.
user.email_address String No

A valid email address. Must not have leading or trailing spaces and address must be RFC compliant. For more information, see RFC 3696.
user.ip_address String No

An IPv4 or IPV6 address.
user.depository_accounts[] Array No

Provide a list of bank accounts that are associated with this Beacon User. These accounts will be scanned across the Beacon Network and used to find duplicate records.

Note: These accounts will not have Bank Account Insights. To receive Bank Account Insights please supply access_tokens.
user.depository_accounts[].routing_number String Yes

The routing number of the account.
user.depository_accounts[].account_number String Yes

Must be a valid US Bank Account Number
user.id_number Object No

The ID number associated with a Beacon User.
user.id_number.type String Yes

A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see Hybrid Input Validation.

Possible values:

  • "sg_nric"
  • "se_pin"
  • "cl_run"
  • "ke_huduma_namba"
  • "ca_sin"
  • "es_nie"
  • "za_smart_id"
  • "ng_nin"
  • "es_dni"
  • "om_civil_id"
  • "ar_dni"
  • "jo_civil_id"
  • "kw_civil_id"
  • "mx_rfc"
  • "eg_national_id"
  • "dk_cpr"
  • "jp_my_number"
  • "in_pan"
  • "nz_drivers_license"
  • "tr_tc_kimlik"
  • "cn_resident_card"
  • "mx_curp"
  • "br_cpf"
  • "sa_national_id"
  • "us_ssn_last_4"
  • "au_passport"
  • "co_nit"
  • "ph_psn"
  • "hk_hkid"
  • "pl_pesel"
  • "my_nric"
  • "ro_cnp"
  • "us_ssn"
  • "it_cf"
  • "au_drivers_license"
user.id_number.value String Yes

Value of identity document value typed in by user. Alpha-numeric, with all formatting characters stripped. For specific format requirements by ID type, see Hybrid Input Validation.
user.address Object No

Home address for the associated user. For more context on this field, see Input Validation by Country.
user.address.street2 String No

Extra street information, like an apartment or suite number. If provided, a string with at least one non-whitespace character, with a max length of 50 characters.
user.address.region String No

An ISO 3166-2 subdivision code. Related terms would be "state", "province", "prefecture", "zone", "subdivision", etc.
user.address.postal_code String No

The postal code for the associated address. Between 2 and 10 alphanumeric characters. For US-based addresses this must be 5 numeric digits.
user.address.country String Yes

Valid, capitalized, two-letter ISO code representing the country of this object. Must be in ISO 3166-1 alpha-2 form.
user.address.street String Yes

The primary street portion of an address. If an address is provided, this field will always be filled. A string with at least one non-whitespace alphabetical character, with a max length of 80 characters.
user.address.city String Yes

City from the end user's address. A string with at least one non-whitespace alphabetical character, with a max length of 100 characters."
user.phone_number String No

A phone number in E.164 format.
program_id String Yes

ID of the associated Beacon Program.
client_user_id String Yes

A unique ID that identifies the end user in your system. 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.
secret String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy