CommonEntity persons

Get a person

Path parameters

person_idstringRequired

Headers

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.

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 or null
The person's address
citizenshipenum or null

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

Errors