Update a key person

Update a key person's details

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

Path Parameters

Name	Type	Description
user_id*	string	The uuid of the user
key_person_id*	string	The uuid of the key person

Request Body

Name	Type	Description
address	object	The person's address. Must be a valid US address. For the address schema, see The user object.
middle_name	string	The person's middle name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
first_name	string	The person's first name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
email	string	The person's email address.
dob	string	The person's date of birth, formatted as YYYY/MM/DD. The minimum age accepted is 18 years old.
ssn	string	The person'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 person's phone number. Must be a valid US phone number.
last_name	string	The person's last name. Must pass the regex ^([aA-zZ]+[,.]?[ ]?|[aA-zZ]+['’-]?)+$
title	string	The person's role at the company. Acceptable values: "OWNER", "DIRECTOR", "BENEFICIARY"

200: OK Key person successfully updated

{
    "uuid": "2acf04c3-48d1-456f-a54e-1m4251814478",
    "first_name": "Blair",
    "middle_name": "Cassidy",
    "last_name": "Dufresne",
    "title": "BENEFICIARY",
    "citizenship": "US",
    "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
}