Create Application

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

Create an Application 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
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. Required if lead_id is not specified

unit_idstring

The Propexo unique identifier for the unit

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

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

last_namestring

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

address_1string

The first address line associated with the applicant

address_2string

The second address line associated with the applicant

citystring

The city associated with the applicant

statestring

The state associated with the applicant

zipstring

The zip code associated with the applicant

attachments object[]
Files to upload for the application
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}$
email_1string<email>

The primary email address associated with the applicant

move_in_datestring
The desired move-in date to the unit listed in the application
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
phone_1string

Primary phone number associated with the applicant

Possible values: Value must match regular expression ^\d{10}$

pets object[]
A list of applicant pets. Note: This will only be added to the primary applicant on the application.
Possible values: <= 6
Array [
typestringrequired
The type associated with the applicant pet
namestring
The name associated with the applicant pet
age_in_yearsinteger
The age in years of the applicant pet
Possible values: >= 0
weight_in_poundsinteger
The weight in pounds of the applicant pet
Possible values: >= 0
breedstring
The breed of the applicant pet
colorstring
The color of the applicant pet
genderstring
The raw value for the gender of the applicant pet
is_fixedboolean
Whether the applicant pet is fixed
is_service_animalboolean
Whether the applicant pet is a service animal
]
vehicles object[]
A list of vehicles for the application. Note: This will only be added to the primary applicant on the application.
Possible values: <= 4
Array [
makestringrequired
The make of the vehicle
modelstring
The model of the vehicle
yearinteger
The year the vehicle was made
colorstring
The color of the vehicle
license_plate_numberstring
The license plate number of the vehicle
license_plate_statestring
The issuing state of the license plate
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYT
]
employment_history object[]
The employment history of the applicant. Note: This will only be added to the primary applicant on the application.
Possible values: <= 2
Array [
is_current_employerbooleanrequired
Whether this employment history entry is for a current employer
namestringrequired
The name of the employer
start_datestringrequired
The start date of the applicant's employment at this employer
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. Ignore this field if is_current_employer is set to true
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
address_1string
The first line of the address of the employer
citystring
The city of the address of the employer
statestring
The state of the address of the employer
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYT
zipstring
The zip code of the address of the employer
phonestringdeprecated
The phone number of the employer. DEPRECATED: Use supervisor_phone instead
Possible values: Value must match regular expression ^\d{10}$
supervisor_phonestring
The phone number of the applicant's supervisor
Possible values: Value must match regular expression ^\d{10}$
supervisor_first_namestring
The first name of the applicant's supervisor at this employer
supervisor_last_namestring
The last name of the applicant's supervisor at this employer
positionstring
The position held at this employer, or the job description of the applicant
monthly_income_in_centsintegerdeprecated
The monthly income of the applicant at this employer in cents. DEPRECATED: Use income_in_cents instead
Possible values: >= 0
income_in_centsintegerdeprecated
The monthly income of the applicant at this employer in cents.
Possible values: >= 0
]
add_ons object[]
Add-ons of the application
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}$
]
other_occupants object[]
A list of other occupants for the application
Array [
relationshipstringrequired
The relationship of the occupant to the applicant
Show 4 enum values
ROOMMATESPOUSEGUARANTOROTHER
first_namestringrequired
The first name associated with the occupant
last_namestringrequired
The last name associated with the occupant
third_party_idstringrequired
A unique ID you would like to associate with the occupant. This is not the Yardi occupant ID
organization_namestringrequired
The name of your organization. Yardi uses this for associating an occupant
email_1string<email>
The primary email address associated with the occupant
phone_1string
Primary phone number associated with the occupant
Possible values: Value must match regular expression ^\d{10}$
phone_1_typestring
Type of the primary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
phone_2string
Secondary phone number associated with the occupant
Possible values: Value must match regular expression ^\d{10}$
phone_2_typestring
Type of the secondary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
address_1string
The first address line associated with the occupant
citystring
The city associated with the occupant
statestring
The state associated with the occupant
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYT
zipstring
The zip code associated with the occupant
]
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 for the applicant

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

middle_namestring

The middle name associated with the applicant

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
Show 2 enum values
SINGLEMARRIED
maiden_namestring

The maiden name associated with the applicant

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_1_typestring
Type of the primary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
phone_2string

Secondary phone number associated with the applicant

Possible values: Value must match regular expression ^\d{10}$

phone_2_typestring
Type of the secondary phone number
Show 4 enum values
FAXHOMEMOBILEWORK
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 of the applicant

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

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. Note: This will only be added to the primary applicant on the application.
Possible values: <= 1
Array [
first_namestringrequired
The first name of the emergency contact
last_namestringrequired
The last name of the emergency contact
relationshipstringrequired
The relationship of the emergency contact to the applicant
Show 6 enum values
DAUGHTERFRIENDHUSBANDSONWIFEOTHER
address_1string
The first line of the address of the emergency contact
citystring
The city of the address of the emergency contact
statestring
The state of the address of the emergency contact
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYT
zipstring
The zip code of the address of the emergency contact
countrystring
The country of the address of the emergency contact. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help
Show 2 variants
• stringUSCA
• string
phone_1string
The phone number of the emergency contact
Possible values: Value must match regular expression ^\d{10}$
]
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}$
]
address_history object[]
The address history of the applicant. Note: This will only be added to the primary applicant on the application.
Possible values: <= 2
Array [
address_1stringrequired
The first address line associated with the applicant's historical address
citystringrequired
The city associated with the applicant's historical address
statestringrequired
The state associated with the applicant
Show 70 enum values
AAAEAKALAPARASAZCACOCTDCDEFLFMGAGUHIIAIDINKSKYLAMAMDMEMHMIMNMOMPMSMTNCNENLNJNMNVNYOHOKORPAPRSDTNTXUTVAVIVTWAWIWVWYABBCMBNBNLNTNSNUONPEQCSKYT
zipstringrequired
The zip code associated with the applicant's historical address
countrystring
The country associated with the applicant's historical address. If your application needs to support submitting an applicant who resides in another country, please reach out to Propexo Support for help
Show 2 variants
• stringUSCA
• string
notice_providedbooleanrequired
Whether notice has been given to the applicant's historical address
property_namestring
The property name of the applicant's historical address
reason_for_leavingstring
The reason the applicant left their historical address
monthly_payment_in_centsinteger
For the applicant's historical address, the applicant's monthly payment for rent or mortgage in cents
Possible values: >= 0
move_in_datestringrequired
The date when the applicant moved into their historical address
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
move_out_datestring
The date when the applicant moved out of their historical address. If this is the applicant's current address, omit this field
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
manager_phonestring
The phone number of a property manager who works at this address
Possible values: Value must match regular expression ^\d{10}$
manager_emailstring<email>
The email of a property manager who works at this address
management_companystring
The name of the company who owns the property at this address
]
other_income object[]
A list of other income sources for the applicant. Note: This will only be added to the primary applicant on the application.
Possible values: <= 2
Array [
sourcestringrequired
The source of the income for the applicant
monthly_income_in_centsintegerrequired
The monthly income from this income source in cents
Possible values: >= 0
]
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

employee_idstring

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

application_datestring
The application date associated with the applicant
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
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
notesstring

Notes associated with the applicant

desired_lease_term_in_monthsstring

The desired lease term in months of the applicant

floor_plan_idstring

The Propexo unique identifier for the floor plan

lead_idstring

The Propexo unique identifier for the lead. The lead will be converted to an applicant

third_party_idstring

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

Possible values: non-empty

organization_namestring

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

move_out_datestring
The desired move-out date to the unit listed in the application
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
is_evictedboolean

Whether the applicant has been evicted

is_felonyboolean

Whether the applicant has a felony

is_criminal_chargeboolean

Whether the applicant has a criminal charge

eviction_descriptionstring

The description of the eviction

felony_descriptionstring

The description of the felony

criminal_charge_descriptionstring

The description of the criminal charge

concession_fees object[]
A list of concession fees for the application
Array [
start_datestringrequired
The start date of the applicant's recurring concession fee
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
end_datestringrequired
The end date of the applicant's recurring concession fee
Show 2 variants
• string<date-time>
• stringPattern: ^\d{4}-\d{2}-\d{2}$
concession_idstringrequired
The Propexo unique identifier for the concession. This concession must be associated with the unit that the applicant is applying for
]
application_fees object[]
A list of application fees for the application
Array [
charge_code_idstringrequired
The Propexo unique identifier for the charge code. This must be an application fee charge code
amount_in_centsintegerrequired
The application fee amount in cents
Possible values: >= 0
descriptionstring
Description of the application fee
]

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/applications/

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

200 Successful response

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