Request
This endpoint expects an object.
emailstringRequiredformat: "email"
The person's email address
first_namestringRequired1-100 characters
The person's first name
last_namestringRequired1-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_numberstringOptional1-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
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
