Update a person

PATCH

Path parameters

person_idstringRequired

Headers

Auth
AuthorizationstringRequired
Bearer authentication of the form Bearer <token>, where token is your auth token.
x-monite-versionstringRequired
x-monite-entity-idstringRequired
The ID of the entity that owns the requested resource.

Request

This endpoint expects an object.
addressobjectOptional
The person's address
date_of_birthstringOptional
The person's date of birth
first_namestringOptional
The person's first name
last_namestringOptional
The person's last name
emailstringOptional
The person's email address
phonestringOptional
The person's phone number
relationshipobjectOptional
Describes the person's relationship to the entity
id_numberstringOptional
The person's ID number, as appropriate for their country
ssn_last_4stringOptional
The last four digits of the person's Social Security number
citizenshipenumOptional
Required for persons of US entities. The country of the person's citizenship, as a two-letter country code (ISO 3166-1 alpha-2). In case of dual or multiple citizenship, specify any.

Response

This endpoint returns an object.
idstring
The person's unique identifier
created_atdatetime
Time at which the person was created
updated_atdatetime
Time at which the person was updated
emailstring
The person's email address
entity_idstring
Entity ID
first_namestring
The person's first name
last_namestring
The person's last name
relationshipobject
Describes the person's relationship to the entity
addressobjectOptional
The person's address
citizenshipenumOptional
Required for persons of US entities. The country of the person's citizenship, as a two-letter country code (ISO 3166-1 alpha-2). In case of dual or multiple citizenship, specify any.
created_by_entity_user_idstringOptional
ID of the entity user who created this person, or null if the person was created using a partner access token.
date_of_birthstringOptional
The person's date of birth
id_numberstringOptional
The person's ID number, as appropriate for their country
phonestringOptional
The person's phone number
ssn_last_4stringOptional
The last four digits of the person's Social Security number

Errors