PMS Generic APIsApplicants

Update applicant

Update an applicant for an integration.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The ID of the resource.

Request

This endpoint expects an object.
last_namestringOptional
The last name associated with the applicant
first_namestringOptional
The first name associated with the applicant
unit_idstringOptional
The Propexo unique identifier for the unit
email_1stringOptional
The primary email address associated with the applicant
phone_1stringOptional
Primary phone number associated with the applicant
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptional
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
applicant_idstringOptional
The Propexo unique identifier for the applicant
application_idstringOptional
The Propexo unique identifier for the application
lease_period_idstringOptional
The lease period to use for the application. If supplied, this field must be one of the approved lease periods defined on the Rentvine template. You can see a list of available choices for each application template on the appropriate lease period endpoint. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements or to change the list of available lease periods
lead_source_idstringOptional
The Propexo unique identifier for the lead source
address_1stringOptional
The first address line associated with the applicant
address_2stringOptional
The second address line associated with the applicant
application_statusenumOptional
The status associated with the application
Allowed values:
attachmentslist of objectsOptional
Files to upload for the applicant. All the files can have a maximum combined file size of 50 MB
citystringOptional
The city associated with the applicant
create_new_events_onlyboolean or stringOptional
Whether or not new events should be created on the applicant
date_of_birthstringOptionalformat: "date-time"
The date of birth associated with the applicant
move_in_datestringOptionalformat: "date-time"

The move-in date associated with the lease

statestringOptional
The state associated with the applicant
zipstringOptional
The zip code associated with the applicant
petslist of objectsOptional
A list of applicant pets. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
vehicleslist of objectsOptional
A list of vehicles for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
employment_historylist of objectsOptional
The employment history of the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
add_onslist of objectsOptional

Add-ons of the applicant. These will be added as new add-ons for the applicant

address_type_idstringOptional
The Propexo unique identifier for the address type. This is required when updating the address
target_move_in_datestringOptional
The target move in date for the applicant
desired_num_bedroomsdoubleOptional
The desired number of bedrooms
desired_num_bathroomsstringOptional
The desired number of bathrooms
desired_lease_term_in_monthsdoubleOptional
The desired lease term in months of the applicant
number_of_occupantsdoubleOptional
The number of occupants for the applicant
notesstringOptional
Notes associated with the applicant
applicant_statusenumOptional
The status of the applicant. This is optional and defaults to ACTIVE.
Allowed values:
middle_namestringOptional
The middle name associated with the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
countrystringOptional
The country associated with the applicant
integration_idstringOptional
The Propexo unique identifier for the integration
application_template_idstringOptional
The Propexo unique identifier for the application template. The Rentvine application template dynamically defines which fields are required for each applicant/application: whether a field is active, disabled, required, or optional. A template may also allow some enums to be modified or for entire fields to be relabeled/repurposed. The functionality of a template is extensive and will likely require that you work with your customer to define a custom template for your application use case
leasing_agent_first_namestringOptional
The first name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
leasing_agent_last_namestringOptional
The last name of the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
leasing_agent_contact_infostringOptional
The contact info for the leasing agent. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
rent_amount_in_centsintegerOptional>=0
The rent amount in cents that the applicant will pay for the unit. This field is not configurable on the Rentvine template and is always required
security_deposit_in_centsintegerOptional>=0
The security deposit in cents that the applicant will pay for the unit. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
typeenumOptional

The type of applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template

Allowed values:
marital_statusenumOptional

The marital status of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements. Although the field itself can be made optional/required, the value must be one of the available choices and cannot be modified as part of the template

maiden_namestringOptional
The maiden name or birth name of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
heightstringOptional
The height of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
weightstringOptional
The weight of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
eye_colorstringOptional
The eye color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
hair_colorstringOptional
The hair color of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
phone_3stringOptionalformat: "^\+?\d{1,50}$"
Third phone number associated with the applicant. An applicant can have no more than one of each phone type. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
phone_3_typeenumOptional
Type of the third phone number. An applicant can have no more than one of each phone type.
Allowed values:
identification_numberstringOptional

The Social Security Number or Individual Taxpayer Identification Number associated with the applicant. Rentvine uses a pre-2011 validation scheme for SSN’s meaning that some valid SSNs will be incorrectly rejected. Reach out to support if you find that a valid SSN is being rejected. This field is not configurable on the Rentvine template and is always required

citizenshipstringOptional
The country of citizenship of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
place_of_birthstringOptional
The place of birth of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
passport_numberstringOptional
The passport number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
student_idstringOptional
The student ID number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
drivers_license_numberstringOptional
The driver's license number of the applicant. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
drivers_license_statestringOptional
The issuing state of the applicant's driver's license. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
lead_sourcestringOptional
The name of the source of the lead or how the applicant heard of the property management company. Depending on the Rentvine template, this field can be customized to be either required or optional. You will need to work with your customer directly to configure this field to your application requirements
emergency_contactslist of objectsOptional
A list of emergency contacts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
application_referenceslist of objectsOptional
A list of applicant references for the application. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
other_occupantslist of objectsOptional
A list of other occupants who will live in the unit, such as children, etc. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Do not include any applicants in this list. If your application use case requires creating multiple applicants in the same application, please reach out to Propexo Support for help.
address_historylist of objectsOptional
The address history of the applicant. At least one address (the current address) must be provided. Note that Rentvine allows configuring different application template requirements for the current address vs. historical addresses. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements. Assuming that a minimum number of addresses are required in the application template, the current address does not count towards the minimum number
other_incomelist of objectsOptional
A list of other income sources for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
bank_accountslist of objectsOptional
A list of bank accounts for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
credit_cardslist of objectsOptional
A list of credit cards for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
assistanceobjectOptional
Details for payment assistance for the applicant. Depending on the Rentvine template, this array can be customized to be either required or optional. The template may also require a minimum number of items in the array in order to pass validation. You will need to work with your customer directly to configure this field to your application requirements
application_datestringOptionalformat: "date-time"
The application date associated with the applicant
start_datestringOptionalformat: "date-time"
The start date associated with the applicant
end_datestringOptionalformat: "date-time"
The end date associated with the applicant
statusenumOptional
The status associated with the applicant
Allowed values:
rent_amount_market_in_centsintegerOptional
The market rent amount in cents for the lease
eventslist of objectsOptionalDeprecated

DEPRECATED: Please use /events endpoints to write events. Array of events associated with this applicant

Response

Successful response
job_idstring
The ID of the job created to handle this operation
dataobject

Errors