Create applicant

POSThttps://api.propexo.com/v1/applicants/

Create an applicant for an integration.

Authentication

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

Request

This endpoint expects an object.

integration_idstringrequired
unit_idstring

The Propexo unique identifier for the unit

first_namestring

The first name associated with the applicant

last_namestring

The last name associated with the applicant

send_rental_application_emailboolean
Whether to send the new applicant an email with a link to the online application form
Default value: false
email_1string

The primary email address associated with the applicant

phone_1string

Primary phone number associated with the applicant

phone_1_typestring
Type of the primary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
phone_2string

Secondary phone number associated with the applicant

phone_2_typestring
Type of the secondary phone number
Show 5 enum values
FAXHOMEMOBILEOTHERWORK
custom_data objectdeprecated
Deprecated: Field is no longer applicable
object
property_idstring

The Propexo unique identifier for the property

lease_period_idstring

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_idstring

The Propexo unique identifier for the lead source

address_1string

The first address line associated with the applicant

application_statusstring
The status associated with the application
Show 2 enum values
COMPLETEDAPPROVED
citystring

The city associated with the applicant

statestring

The state associated with the applicant

zipstring

The zip code associated with the applicant

address_2string

The second address line associated with the applicant

attachments object[]
Files to upload for the applicant
Array [
file_datastringrequired
The contents of the file, as a base64 encoded string. The PMS has a max file size of 50 MB.
Possible values: <= 69730304 characters
file_namestringrequired
The name of the file including the extension. Ex: "image.jpg"
mime_typestringrequired
The mime type of the file. Ex: "image/jpeg"
lease_file_typestring
Deprecated: Use the file_type_id field instead. The PMS specific lease file type of the document
file_type_idstring
The Propexo file type ID of the lease file type to upload. Prefer this over the raw input of the lease_file_type.
is_privateboolean
If the file should be marked as private. If true the file will not be shown in the resident portal.
]
date_of_birthstring
The date of birth associated with the applicant
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
events object[]
A list of events to create for the new applicant
Array [
employee_idstringrequired
The Propexo unique identifier for the employee
lead_source_idstring
The Propexo unique identifier for the lead source
unit_idstring
The Propexo unique identifier for the unit. Only some events use this, including "Show" and "Appointment".
event_namestringrequired
The name or type of event. This has to be from a predefined set of events.
Show 13 enum values
CallToProspectCallFromProspectOtherWalkInChatEmailTextWebserviceAppointmentShowApplicationSelfGuidedTourApplication
event_datetimestring<date-time>required
The date when the event will occur
notesstring
Notes associated with the event
Possible values: <= 256 characters
reasons_for_eventstring
The reasons for the event
]
move_in_datestring
The move-in date associated with the lease
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
pets object[]
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
Array [
namestring
The name associated with the applicant pet. 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
typestringrequired
The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required
age_in_yearsinteger
The age in years of the applicant pet. 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
Possible values: >= 0
weight_in_poundsinteger
The weight in pounds of the applicant pet. 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
Possible values: >= 0
is_trainedboolean
Whether the applicant pet is trained. 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
colorstring
The color of the applicant pet. 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
genderstring
The gender of the applicant pet. 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
Show 3 enum values
MALEFEMALEUNSPECIFIED
is_declawedboolean
Whether the applicant pet is declawed. 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
is_vaccinatedboolean
Whether the applicant pet is vaccinated. 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
is_fixedboolean
Whether the applicant pet is fixed. 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
]
vehicles object[]
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
Array [
makestringrequired
The make of the vehicle. This field is not configurable on the Rentvine template and is always required
modelstring
The model of the vehicle. 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
yearinteger
The year the vehicle was made. 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
colorstring
The color of the vehicle. 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
license_plate_numberstring
The license plate number of the vehicle. 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
license_plate_statestring
The issuing state of the license plate. 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
monthly_payment_in_centsinteger
If the vehicle is leased or financed, the applicant's monthly payment for the vehicle in cents. 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
Possible values: >= 0
insurance_carrierstring
The insurance carrier for the applicant's vehicle. 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
]
employment_history object[]
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
Array [
is_current_employerbooleanrequired
Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required
namestringrequired
The name of the employer. This field is not configurable on the Rentvine template and is always required
phonestring
The phone number of the employer. 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
Possible values: Value must match regular expression ^\+?\d{1,50}$
address_1string
The first line of the address of the employer. 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
address_2string
The second line of the address of the employer. 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
citystring
The city of the address of the employer. 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
statestring
The state of the address of the employer. 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
zipstring
The zip code of the address of the employer. 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
countrystring
The country of the address of the employer. 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
supervisor_first_namestring
The first name of the applicant's supervisor at this employer. 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
supervisor_last_namestring
The last name of the applicant's supervisor at this employer. 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
supervisor_titlestring
The title of the applicant's supervisor at this employer. 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
supervisor_phonestring
The phone number of the applicant's supervisor at this employer. 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
Possible values: Value must match regular expression ^\+?\d{1,50}$
supervisor_emailstring<email>
The email of the applicant's supervisor at this employer. 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
positionstring
The position held at this employer, or the job description 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
monthly_income_in_centsintegerdeprecated
The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required. DEPRECATED: Use income_in_cents instead
Possible values: >= 0
income_in_centsinteger
The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required
Possible values: >= 0
start_datestring
The start date of the applicant's employment at this employer. 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
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
end_datestring
The end date of the applicant's employment at this employer. 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
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
]
add_ons object[]
Add-ons of the applicant
Array [
rentable_item_idstringrequired
The Propexo unique identifier for the rentable item
employee_idstringrequired
The Propexo unique identifier for the employee
start_datestring
The start date associated with the employee
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
end_datestring
The end date associated with the employee
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
]
address_type_idstring

The Propexo unique identifier for the address type

target_move_in_datestring
The move-in date associated with the lead. The timestamp will be stripped off and only the date will be used
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
desired_num_bedroomsnumber

The desired number of bedrooms

desired_num_bathroomsstring

The desired number of bathrooms

desired_lease_term_in_monthsstring

The amount of months for the lease term

number_of_occupantsnumber

The number of occupants for the applicant

notesstring

Notes associated with the applicant

applicant_statusstring
The status of the applicant. This is optional and defaults to ACTIVE.
Show 3 enum values
APPLICANTCO_APPLICANTOCCUPANT
middle_namestring

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

application_datestring
The application date associated with the applicant
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
application_template_idstring

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_namestring

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_namestring

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_infostring

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_centsinteger

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

Possible values: >= 0

security_deposit_in_centsinteger

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

Possible values: >= 0

typestring
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
Show 4 enum values
APPLICANTCO_APPLICANTOCCUPANTGUARANTOR
marital_statusstring
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
Show 7 enum values
SINGLEMARRIEDENGAGEDSEPARATEDDIVORCEDWIDOWEDUNMARRIED_PARTNERS
maiden_namestring

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

heightstring

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

weightstring

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_colorstring

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_colorstring

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_3string

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

Possible values: Value must match regular expression ^\+?\d{1,50}$

phone_3_typestring
Type of the third phone number. An applicant can have no more than one of each phone type.
Show 3 enum values
HOMEWORKMOBILE
identification_numberstring

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

citizenshipstring

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_birthstring

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_numberstring

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_idstring

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_numberstring

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_statestring

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_sourcestring

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_contacts object[]
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
Array [
first_namestring
The first name of the emergency contact. 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
last_namestring
The last name of the emergency contact. 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
relationshipstring
The relationship of the emergency contact to 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
address_1string
The first line of the address of the emergency contact. 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
address_2string
The second line of the address of the emergency contact. 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
citystring
The city of the address of the emergency contact. 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
statestring
The state of the address of the emergency contact. 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
zipstring
The zip code of the address of the emergency contact. 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
countrystring
The country of the address of the emergency contact. 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_1string
The phone number of the emergency contact. 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
Possible values: Value must match regular expression ^\+?\d{1,50}$
phone_2string
The second phone number of the emergency contact. 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
Possible values: Value must match regular expression ^\+?\d{1,50}$
email_1string<email>
The email of the emergency contact. 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
]
application_references object[]
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
Array [
first_namestringrequired
The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required
last_namestringrequired
The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required
relationshipstring
The relationship of the applicant's reference to 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
address_1string
The first line of the address of the applicant's reference. 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
address_2string
The second line of the address of the applicant's reference. 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
citystring
The city of the address of the applicant's reference. 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
statestring
The state of the address of the applicant's reference. 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
zipstring
The zip code of the address of the applicant's reference. 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
countrystring
The country of the address of the applicant's reference. 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_1string
The phone number of the applicant's reference. 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
Possible values: Value must match regular expression ^\+?\d{1,50}$
]
other_occupants object[]
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.
Array [
first_namestringrequired
The first name of the occupant. This field is not configurable on the Rentvine template and is always required
last_namestringrequired
The last name of the occupant. This field is not configurable on the Rentvine template and is always required
date_of_birthstring
The date of birth of the occupant. 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
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
relationshipstringrequired
The relationship of the occupant to the applicant. The only allowed value is "OTHER" and is used to represent non-applicants under 18 years old. Contact Propexo Support if you need to support a workflow that allows adding additional applicants to an application
Show 1 enum value
OTHER
relationship_detailstring
The relationship detail of the occupant to 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
]
address_history object[]
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
Possible values: >= 1
Array [
address_1stringrequired
The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required
address_2string
The second address line associated with the applicant's historical address. 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
citystringrequired
The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required
statestringrequired
The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required
Show 73 enum values
ABBCMBNBNLNTNSNUONPEQCSKYTALAKASAZARAAAEAPCACOCTDEDCFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDMPOHOKORPAPRRISCSDTNTXUMUTVTVIVAWAWVWIWY
zipstringrequired
The zip code associated with the applicant's historical address. 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
countrystringrequired
The country associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required. If your application needs to support submitting an applicant who previously or currently reside(s) in another country, please reach out to Propexo Support for help
Show 2 enum values
USCA
address_typestring
Whether the applicant previously owned or rented at this address. 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
Show 2 enum values
OWNRENT
monthly_payment_in_centsinteger
For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents. 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
Possible values: >= 0
move_in_datestring
The date when the applicant moved into this historical address. 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
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
move_out_datestring
The date when the applicant moved out of this address. 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. Leave out this field to indicate that the given array item is the applicant's current address. At least one address in this array (the current address) is required.
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
manager_namestring
The name of a property manager who works at this address. 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
manager_phonestring
The phone number of a property manager who works at this address. 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
Possible values: Value must match regular expression ^\+?\d{1,50}$
manager_emailstring<email>
The email of a property manager who works at this address. 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
reason_for_leavingstring
The reason the applicant decided to leave this address. 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
manager_typestring
The type of property manager who works at this address. This field is ignored for the current address. 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
Show 5 enum values
LANDLORDPROPERTY_MANAGERRELATIVEFRIENDAPARTMENT
]
other_income object[]
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
Array [
sourcestringrequired
The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required
monthly_income_in_centsintegerrequired
The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required
Possible values: >= 0
phonestring
The phone number related to this income source to use for income verification. 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
Possible values: Value must match regular expression ^\+?\d{1,50}$
]
bank_accounts object[]
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
Array [
namestringrequired
The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required
account_typestring
The type of bank account. 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
Show 2 enum values
SAVINGSCHECKING
account_numberstring
The account number of the bank account. 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
balance_in_centsinteger
The current balance of the bank account in cents. 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
Possible values: >= 0
]
credit_cards object[]
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
Array [
namestringrequired
The name of the bank or issuer of the credit card. This field is not configurable on the Rentvine template and is always required
balance_in_centsinteger
The current balance of the credit card in cents. 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
Possible values: >= 0
]
assistance object

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

agency_namestring

The name of the agency who is providing assistance for 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

countystring

The county where the agency is located. 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

technician_namestring

The name of the agency's contact assigned to support 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

phonestring

The phone number of the agency or of the agency's contact. 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

Possible values: Value must match regular expression ^\+?\d{1,50}$

assistance_amount_in_centsinteger

The amount of assistance for the applicant in cents. 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

Possible values: >= 0

beds_allowedstring

The number of beds allowed for 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

are_utilities_coveredboolean

Whether utilities are covered for 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

application_idstring

Optionally, the Propexo unique identifier for the application onto which you'd like to add this applicant. If omitted, Rentvine will create a new application for this applicant.

lead_idstring

The Propexo unique identifier for the lead

start_datestring
The start date associated with the lease
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
end_datestring
The end date associated with the lease
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
statusstring
The status associated with the application
Show 5 enum values
PENDINGAPPROVEDCANCELEDDENIEDSIGNED
rent_amount_market_in_centsinteger

The market rent amount in cents for the lease

employee_idstring

The Propexo unique identifier for the employee

third_party_idstring

A unique value provided to the PMS to uniquely identify the applicant from your system.

Possible values: non-empty

organization_namestring

The name of your organization. Yardi uses this for associating a applicant

Response

Successful response

job_idstringrequired

The ID of the job created to handle this operation

data objectrequired
object

Errors

• 400Bad Request

  error objectrequired
  codestringrequired
  Example: invalid_request
  messagestringrequired
  Example: invalid request
  details object
  property name*any
  Example: {"details":{"issues":[{"code":"unrecognized_keys","keys":["foo"],"path":[],"message":"Unrecognized key(s) in object: 'foo'"}],"name":"ZodError"}}

POST /v1/applicants/

curl -X POST https://api.propexo.com/v1/applicants/ \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "integration_id": "string"
}'

200 Successful response

{
  "job_id": "string",
  "data": {}
}