Update a user
Create a user
PUT https://sandbox-api.com/v1/users/{user_id}
Returns the user object if successful. Returns an error if create parameters are invalid (e.g. specifying an invalid phone number or incorporation date). The EIN is not included in the response.
Path Parameters
user_id*
string
The uuid of the user
Request Body
address*
object
The business's address. Must be a valid US address. For the address schema, see The user object.
first_name*
string
The legal business name
email*
string
The business's email address.
entity*
enum
The type of business. Acceptable values:
'SOLE_PROPRIETORSHIP', 'GENERAL_PARTNERSHIP', 'LIMITED_PARTNERSHIP', 'CORPORATION', 'LIMITED_LIABILITY_COMPANY', 'LIMITED_LIABILITY_PARTNERSHIP'
asset_report_json_gzip
string
The user's Plaid asset report, gzipped with base64 encoding.
EIN*
string
The business's employer identification number (EIN). The EIN must be AES encrypted In CBC Mode using your secret_key (see Creating and Managing Users for more detail)
phone*
string
The business's 10-digit phone number. Must be a valid US phone number.
user_type*
enum
Required to be set to business for commercial users
key_people*
array
A list of owners, directors or other beneficiaries of the business. See the key person object for the schema
Last updated