> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.travtus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Resident

Below is our standard data structure for a resident:

<ParamField body="community_name" type="string" default="none">
  The name of the community for the resident you want to create.
</ParamField>

<ParamField body="community_external_ref" type="string" default="none">
  The external reference of the community for the resident you want create.
</ParamField>

<ParamField body="unit_external_ref" type="string" default="none">
  The external reference for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="lease_external_ref" type="string" default="none">
  The external reference for the vacancy corresponding to the resident you want to create.
</ParamField>

<ParamField body="move_in_date" type="date">
  The move in date for the vacancy corresponding to the resident you want to create.
</ParamField>

<ParamField body="lease_start_date" type="string" default="none">
  The start date for the vacancy corresponding to the resident you want to create.
</ParamField>

<ParamField body="lease_end_date" type="string" default="none">
  The end date for the vacancy corresponding to the resident you want to create.
</ParamField>

<ParamField body="property_type" type="string">
  The type of the property associated with the resident to be created.

  Can be:

  * SF (Single Family)
  * GS (Garden Style)
  * MR (Mid Rise)
  * HR (High Rise)
</ParamField>

<ParamField body="construction_year" type="string" default="none">
  The end date unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="number_of_bedrooms" type="string" default="none">
  The number of bedrooms for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="number_of_bathrooms" type="string" default="none">
  The number of bathrooms for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="sqft" type="float">
  The square feet surface for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="address_1" type="string" default="none">
  The first line of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="address_2" type="string" default="none">
  The second line of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="city" type="string" default="none">
  The city of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="state" type="string" default="none">
  The state of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="country" type="string" default="none">
  The country of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="postal_code" type="string" default="none">
  The postal code of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="longitude" type="string" default="none">
  The longitude of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="latitude" type="string" default="none">
  The latitude of the address for the unit corresponding to the resident you want to create.
</ParamField>

<ParamField body="customer_external_ref" type="string" default="none">
  The external reference for the resident you want to create.
</ParamField>

<ParamField body="first_name" type="string" default="none">
  The first name of the resident you want to create.
</ParamField>

<ParamField body="last_name" type="string" default="none">
  The last name of the resident you want to create.
</ParamField>

<ParamField body="role" type="string" default="none">
  Role of the resident.

  Can be:

  * Prospect
  * Applicant
  * Leasholder
  * Occupant
  * Guarantor
  * Minor
  * ExTenant
</ParamField>

<ParamField body="email_1" type="string" default="none">
  The email address of the resident you want to create.
</ParamField>

<ParamField body="email_2" type="string" default="none">
  An alternative email address for the resident you want to create.
</ParamField>

<ParamField body="email_3" type="string" default="none">
  A third alternative email address for the resident you want to create.
</ParamField>

<ParamField body="phone_1" type="string" default="none">
  The phone number of the resident you want to create.
</ParamField>

<ParamField body="phone_2" type="string" default="none">
  An alternative phone number for the resident you want to create.
</ParamField>

<ParamField body="phone_3" type="string" default="none">
  A third alternative phone number for the resident you want to create.
</ParamField>

<ParamField body="cell_1" type="string" default="none">
  The cell phone number of the resident you want to create.
</ParamField>

<ParamField body="cell_2" type="string" default="none">
  An alternative cell phone number for the resident you want to create.
</ParamField>

<ParamField body="cell_3" type="string" default="none">
  A third alternative cell phone number of the resident you want to create.
</ParamField>

<ParamField body="middle_name" type="string" default="none">
  The middle name of the resident.
</ParamField>

<ParamField body="date_of_birth" type="date" default="none">
  The date of birth of the resident.
</ParamField>

<ParamField body="gender" type="string" default="none">
  The gender of the resident.
</ParamField>

<ParamField body="company_name" type="string" default="none">
  The name of the company where the resident is employed.
</ParamField>

<ParamField body="job_title" type="string" default="none">
  The job title of the resident at their company.
</ParamField>

<ParamField body="company_address_1" type="string" default="none">
  The first line of the company address for the resident.
</ParamField>

<ParamField body="company_address_city" type="string" default="none">
  The city of the company address for the resident.
</ParamField>

<ParamField body="company_address_state" type="string" default="none">
  The state of the company address for the resident.
</ParamField>

<ParamField body="company_address_zip_code" type="string" default="none">
  The zip code of the company address for the resident.
</ParamField>

<ParamField body="company_phone" type="string" default="none">
  The phone number of the resident's company.
</ParamField>

<ParamField body="company_email" type="string" default="none">
  The email address of the resident at their company.
</ParamField>

<ParamField body="company_start_date" type="date" default="none">
  The start date of the resident's employment at their company.
</ParamField>
