CommonEntity persons

Create a person

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.

Request

This endpoint expects an object.
emailstringRequiredformat: "email"
The person's email address
first_namestringRequired>=1 character<=100 characters
The person's first name
last_namestringRequired>=1 character<=100 characters
The person's last name
relationshipobjectRequired
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.

date_of_birthstringOptionalformat: "date"
The person's date of birth
id_numberstringOptional>=1 character<=100 characters
The person's ID number, as appropriate for their country
phonestringOptional
The person's phone number
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
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_idstringOptionalformat: "uuid"
ID of the entity user who created this person, or null if the person was created using a partner access token.
date_of_birthstringOptionalformat: "date"
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