API ReferenceApplications

Create Application

Create an Application for an integration.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
integration_idstringRequired
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
move_in_datedatetime or stringOptional

The desired move-in date to the unit listed in 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
first_namestringOptional

The first name associated with the applicant. Required if lead_id is not specified

middle_namestringOptional
The middle name associated with the applicant
last_namestringOptional

The last name associated with the applicant. Required if lead_id is not specified

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
Allowed values:
maiden_namestringOptional
The maiden name associated with the applicant
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_1stringOptionalformat: "^\d{10}$"
Primary phone number associated with the applicant
phone_1_typeenumOptional
Type of the primary phone number
Allowed values:
phone_2stringOptionalformat: "^\d{10}$"
Secondary phone number associated with the applicant
phone_2_typeenumOptional
Type of the secondary phone number
Allowed values:
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:
email_1stringOptional
The primary email address associated with the applicant
date_of_birthdatetime or stringOptional
The date of birth associated with the applicant
identification_numberstringOptional
The social security number of the applicant
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
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
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
vehicleslist of objectsOptional
A list of vehicles for the application
other_occupantslist of objectsOptional
A list of other occupants for the application
petslist of objectsOptional
A list of applicant pets
address_historylist of objectsOptional
The address history of the applicant
employment_historylist of objectsOptional
The employment history of the applicant
other_incomelist of objectsOptional
A list of other income sources for the applicant
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
unit_idstringOptional
The Propexo unique identifier for the unit
property_idstringOptional
The Propexo unique identifier for the property
lead_idstringOptional
The Propexo unique identifier for the lead. The lead will be converted to an applicant
employee_idstringOptional

The Propexo unique identifier for the employee. Employee must have a role of LEASING_AGENT. Required if lead_id is not specified

lead_source_idstringOptional

The Propexo unique identifier for the lead source. Required if lead_id is not specified

third_party_idstringOptional

A unique ID you would like to associate with the applicant. This is not the Sample1 applicant ID. Required if lead_id is not specified

organization_namestringOptional

The name of your organization. Sample1 uses this for associating an applicant. Required if lead_id is not specified

move_out_datedatetime or stringOptional

The desired move-out date to the unit listed in the application

desired_lease_term_in_monthsstringOptional
The desired lease term in months of the applicant
notesstringOptional
Notes associated with the applicant
is_evictedbooleanOptionalDefaults to false
Whether the applicant has been evicted
is_felonybooleanOptionalDefaults to false
Whether the applicant has a felony
is_criminal_chargebooleanOptionalDefaults to false
Whether the applicant has a criminal charge
eviction_descriptionstringOptional
The description of the eviction
felony_descriptionstringOptional
The description of the felony
criminal_charge_descriptionstringOptional
The description of the criminal charge
concession_feeslist of objectsOptional
A list of concession fees for the application
application_feeslist of objectsOptional
A list of application fees for the application

Response

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

Errors