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

Name	Type	Description
user_id*	string	The uuid of the user

Name

Type

Description

user_id*

string

The uuid of the user

Request Body

Name Type Description

Name	Type	Description
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

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

{
    "uuid": "50d6c5df-abd6-43de-9c48-d85146e96c11",
    "first_name": "Fairlender Inc",
    "middle_name": null,
    "last_name": null,
    "dwolla_customer_url": null,
    "user_type": "BUSINESS",
    "start_date": "2012-07-04",
    "website": null,
    "entity": "CORPORATION",
    "industry": null,
    "email": "info@fairlender.com",
    "phone": "8478887676",
    "address": {
        "line_1": "77 Geary Street",
        "line_2": null,
        "line_3": null,
        "zip": "94108",
        "city": "San Francisco",
        "state": "CA",
        "country": "UNITED STATES"
    },
    "key_people": [
        {
            "uuid": "3189f45f-bdb1-4115-ab41-dde4d6207edb",
            "first_name": "Blair",
            "last_name": "Cassidy",
            "middle_name": "Dufresne",
            "title": "BENEFICIARY",
            "phone": "6166723456",
            "email": "bcdufresne5000@gmail.com",
            "citizenship": "US",
            "address": {
                "line_1": "161 Stansfield Dr",
                "city": "Zionsville",
                "state": "PA",
                "zip": "18092",
                "country": "UNITED STATES"
            }
        }
    ]
}

{
    // Response
}

{
    // Response
}

PreviousRetrieve a user NextDelete a user

Last updated 2 years ago