CommonEntity persons

Update a person

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

person_idstringRequired

Headers

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
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.

date_of_birthstringOptionalformat: "date"
The person's date of birth
emailstringOptionalformat: "email"
The person's email address
first_namestringOptional1-100 characters
The person's first name
id_numberstringOptional1-100 characters
The person's ID number, as appropriate for their country
last_namestringOptional1-100 characters
The person's last name
phonestringOptional
The person's phone number
relationshipobjectOptional
Describes the person's relationship to the entity
ssn_last_4stringOptional=4 characters
The last four digits of the person's Social Security number

Response

Successful Response
idstringformat: "uuid"
The person's unique identifier
created_atdatetime
Time at which the person was created
updated_atdatetime
Time at which the person was updated
emailstringformat: "email"
The person's email address
entity_idstringformat: "uuid"
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
addressobject
The person's address
citizenshipenum

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_idstringformat: "uuid"
ID of the entity user who created this person, or null if the person was created using a partner access token.
date_of_birthstringformat: "date"
The person's date of birth
id_numberstring
The person's ID number, as appropriate for their country
phonestring
The person's phone number
ssn_last_4string
The last four digits of the person's Social Security number

Errors

401
Patch Persons ID Request Unauthorized Error
404
Patch Persons ID Request Not Found Error
409
Patch Persons ID Request Conflict Error
422
Patch Persons ID Request Unprocessable Entity Error
429
Patch Persons ID Request Too Many Requests Error