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
The person's first name
last_namestringRequired
The person's last name
relationshipobjectRequired
Describes the person's relationship to the entity
addressobjectOptional
The person's address
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

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