Update a user

Update a user

PUT https://sandbox-api.com/v1/users/{user_id}

Returns the user object if successful. Returns an error if update parameters are invalid (e.g. specifying an invalid phone number or date of birth). Date of birth and SSN are not included in the response as they are sensitive personal data. Updates the specified user only with the parameters passed. Any parameters not provided will be left unchanged. This request accepts the same parameters as the user creation call, with the exception of SSN

Path Parameters

Name	Type	Description
user_id*	string	The uuid of the user

Request Body

Name	Type	Description
address	object	The user's address. Must be a valid US address.
middle_name	string	The user's middle name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
first_name	string	The user's first name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
email	string	The user's email address.
dob	string	The user's date of birth, formatted as YYYY/MM/DD. The minimum age accepted is 18 years old.
credit_report_xml_gzip	string	The user's credit report, gzipped with base64 encoding.
asset_report_json_gzip	string	The user's Plaid asset report, gzipped with base64 encoding.
ssn	string	The user's social security number (SSN). The SSN must be AES encrypted In CBC Mode using your secret_key (see Creating and Managing Users for more detail)
phone	string	The user's 10-digit phone number. Must be a valid US phone number.
last_name	string	The user's last name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$

200: OK User successfully updated

{
    "uuid": "2acf04c3-48d1-456f-a54e-1m4251814478",
    "first_name": "Blair",
    "middle_name": "Cassidy",
    "last_name": "Dufresne",
    "citizenship": "US",
    "dwolla_customer_url": null,
    "email": "[e-mail]",
    "phone": "6166723456",
    "address": {
        "line_1": "5161 Stansfield Dr",
        "line_2": null,
        "line_3": null,
        "zip": "18092",
        "city": "Zionsville",
        "state": "PA",
        "country": "UNITED STATES"
    }
}

401: Unauthorized

{
    // Response
}

403: Forbidden

{
    // Response
}