> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.propexo.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.propexo.com/_mcp/server. # Update Applicant: Rentvine PUT https://api.propexo.com/v1/applicants/rentvine/{applicant_id} Content-Type: application/json Update Applicant: Rentvine | Method | Interface | |---|---| | POST /api/manager/screening/applicants | Screening | Reference: https://docs.propexo.com/api-reference/rentvine/applicants/update-applicant-rentvine ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.propexo.com` (Production, default) - `https://api.sandbox.propexo.com` (Sandbox) ## Request ### Path parameters - `applicant_id` (string, required) — The ID of the resource. ### Body (application/json) This endpoint expects a _v1_applicants_rentvine_{applicant_id}_put_input. - `integration_id` (string, required) — The Propexo unique identifier for the integration - `application_template_id` (string, required) — 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 - `rent_amount_in_cents` (integer, required) — 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 - `first_name` (string, required) — The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required - `last_name` (string, required) — The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required - `email_1` (string, required) — The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required - `date_of_birth` (V1ApplicantsRentvineApplicantIdPutInputDateOfBirth, required) — The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required - `identification_number` (string, required) — 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 - `address_history` (list of V1ApplicantsRentvineApplicantIdPutInputAddressHistoryItems, required) — 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 - `leasing_agent_first_name` (string, optional) — 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_name` (string, optional) — 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_info` (string, optional) — 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 - `security_deposit_in_cents` (integer, optional) — 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_date` (V1ApplicantsRentvineApplicantIdPutInputMoveInDate, optional) — The desired move-in date to the unit listed in the application. 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 - `lease_period_id` (string, optional) — 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 - `middle_name` (string, optional) — 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 - `type` (enum, optional) — 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: `APPLICANT`, `CO_APPLICANT`, `OCCUPANT`, `GUARANTOR` - `marital_status` (enum, optional) — 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 - Allowed values: `SINGLE`, `MARRIED`, `ENGAGED`, `SEPARATED`, `DIVORCED`, `WIDOWED`, `UNMARRIED_PARTNERS` - `maiden_name` (string, optional) — 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 - `height` (string, optional) — 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 - `weight` (string, optional) — 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_color` (string, optional) — 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_color` (string, optional) — 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` (string, optional) — Primary 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_1_type` (enum, optional) — Type of the primary phone number. An applicant can have no more than one of each phone type - Allowed values: `HOME`, `WORK`, `MOBILE` - `phone_2` (string, optional) — Secondary 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_2_type` (enum, optional) — Type of the secondary phone number. An applicant can have no more than one of each phone type. - Allowed values: `HOME`, `WORK`, `MOBILE` - `phone_3` (string, optional) — 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_type` (enum, optional) — Type of the third phone number. An applicant can have no more than one of each phone type. - Allowed values: `HOME`, `WORK`, `MOBILE` - `citizenship` (string, optional) — 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_birth` (string, optional) — 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_number` (string, optional) — 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_id` (string, optional) — 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_number` (string, optional) — 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_state` (string, optional) — 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_source` (string, optional) — 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` (list of V1ApplicantsRentvineApplicantIdPutInputEmergencyContactsItems, optional) — 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_references` (list of V1ApplicantsRentvineApplicantIdPutInputApplicationReferencesItems, optional) — 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 - `vehicles` (list of V1ApplicantsRentvineApplicantIdPutInputVehiclesItems, optional) — 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 - `other_occupants` (list of V1ApplicantsRentvineApplicantIdPutInputOtherOccupantsItems, optional) — 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. - `pets` (list of V1ApplicantsRentvineApplicantIdPutInputPetsItems, optional) — 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 - `employment_history` (list of V1ApplicantsRentvineApplicantIdPutInputEmploymentHistoryItems, optional) — 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 - `other_income` (list of V1ApplicantsRentvineApplicantIdPutInputOtherIncomeItems, optional) — 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_accounts` (list of V1ApplicantsRentvineApplicantIdPutInputBankAccountsItems, optional) — 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_cards` (list of V1ApplicantsRentvineApplicantIdPutInputCreditCardsItems, optional) — 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 - `assistance` (V1ApplicantsRentvineApplicantIdPutInputAssistance, optional) — 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 ## Response ### 200 Successful response - `meta` (V1ApplicantsRentvineApplicantIdPutOutputMeta, required) - `result` (V1ApplicantsRentvineApplicantIdPutOutputResult, required) ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorResponseError, required) ## Types ### V1ApplicantsRentvineApplicantIdPutInputDateOfBirth The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required ### V1ApplicantsRentvineApplicantIdPutInputAddressHistoryItems - `address_1` (string, required) — The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required - `city` (string, required) — The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required - `state` (enum, required) — The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required - Allowed values: `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`, `AL`, `AK`, `AS`, `AZ`, `AR`, `AA`, `AE`, `AP`, `CA`, `CO`, `CT`, `DE`, `DC`, `FL`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MI`, `MN`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `MP`, `OH`, `OK`, `OR`, `PA`, `PR`, `RI`, `SC`, `SD`, `TN`, `TX`, `UM`, `UT`, `VT`, `VI`, `VA`, `WA`, `WV`, `WI`, `WY` - `zip` (string, required) — 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 - `country` (enum, required) — 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 - Allowed values: `US`, `CA` - `address_2` (string, optional) — 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 - `address_type` (enum, optional) — 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 - Allowed values: `OWN`, `RENT` - `monthly_payment_in_cents` (integer, optional) — 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 - `move_in_date` (V1ApplicantsRentvineApplicantIdPutInputAddressHistoryItemsMoveInDate, optional) — 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 - `move_out_date` (V1ApplicantsRentvineApplicantIdPutInputAddressHistoryItemsMoveOutDate, optional) — 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. - `manager_name` (string, optional) — 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_phone` (string, optional) — 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 - `manager_email` (string, optional) — 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_leaving` (string, optional) — 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_type` (enum, optional) — 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 - Allowed values: `LANDLORD`, `PROPERTY_MANAGER`, `RELATIVE`, `FRIEND`, `APARTMENT` ### V1ApplicantsRentvineApplicantIdPutInputMoveInDate The desired move-in date to the unit listed in the application. 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 ### V1ApplicantsRentvineApplicantIdPutInputEmergencyContactsItems - `first_name` (string, optional) — 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_name` (string, optional) — 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 - `relationship` (string, optional) — 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_1` (string, optional) — 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_2` (string, optional) — 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 - `city` (string, optional) — 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 - `state` (string, optional) — 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 - `zip` (string, optional) — 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 - `country` (string, optional) — 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_1` (string, optional) — 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 - `phone_2` (string, optional) — 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 - `email_1` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputApplicationReferencesItems - `first_name` (string, required) — The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required - `last_name` (string, required) — The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required - `relationship` (string, optional) — 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_1` (string, optional) — 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_2` (string, optional) — 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 - `city` (string, optional) — 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 - `state` (string, optional) — 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 - `zip` (string, optional) — 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 - `country` (string, optional) — 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_1` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputVehiclesItems - `make` (string, required) — The make of the vehicle. This field is not configurable on the Rentvine template and is always required - `model` (string, optional) — 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 - `year` (integer, optional) — 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 - `color` (string, optional) — 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_number` (string, optional) — 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_state` (string, optional) — 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_cents` (integer, optional) — 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 - `insurance_carrier` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputOtherOccupantsItems - `first_name` (string, required) — The first name of the occupant. This field is not configurable on the Rentvine template and is always required - `last_name` (string, required) — The last name of the occupant. This field is not configurable on the Rentvine template and is always required - `relationship` (enum, required) — 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 - Allowed values: `OTHER` - `date_of_birth` (V1ApplicantsRentvineApplicantIdPutInputOtherOccupantsItemsDateOfBirth, optional) — 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 - `relationship_detail` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputPetsItems - `type` (string, required) — The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required - `name` (string, optional) — 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 - `age_in_years` (integer, optional) — 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 - `weight_in_pounds` (integer, optional) — 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 - `is_trained` (boolean, optional) — 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 - `color` (string, optional) — 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 - `gender` (enum, optional) — 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 - Allowed values: `MALE`, `FEMALE`, `UNSPECIFIED` - `is_declawed` (boolean, optional) — 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_vaccinated` (boolean, optional) — 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_fixed` (boolean, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputEmploymentHistoryItems - `is_current_employer` (boolean, required) — Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required - `name` (string, required) — The name of the employer. This field is not configurable on the Rentvine template and is always required - `phone` (string, optional) — 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 - `address_1` (string, optional) — 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_2` (string, optional) — 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 - `city` (string, optional) — 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 - `state` (string, optional) — 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 - `zip` (string, optional) — 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 - `country` (string, optional) — 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_name` (string, optional) — 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_name` (string, optional) — 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_title` (string, optional) — 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_phone` (string, optional) — 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 - `supervisor_email` (string, optional) — 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 - `position` (string, optional) — 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 - `income_in_cents` (integer, optional) — The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required - `start_date` (V1ApplicantsRentvineApplicantIdPutInputEmploymentHistoryItemsStartDate, optional) — 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 - `end_date` (V1ApplicantsRentvineApplicantIdPutInputEmploymentHistoryItemsEndDate, optional) — 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 - `monthly_income_in_cents` (integer, optional, deprecated) — 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 ### V1ApplicantsRentvineApplicantIdPutInputOtherIncomeItems - `source` (string, required) — The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required - `monthly_income_in_cents` (integer, required) — The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required - `phone` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputBankAccountsItems - `name` (string, required) — The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required - `account_type` (enum, optional) — 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 - Allowed values: `SAVINGS`, `CHECKING` - `account_number` (string, optional) — 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_cents` (integer, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputCreditCardsItems - `name` (string, required) — 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_cents` (integer, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutInputAssistance 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_name` (string, optional) — 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 - `county` (string, optional) — 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_name` (string, optional) — 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 - `phone` (string, optional) — 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 - `assistance_amount_in_cents` (integer, optional) — 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 - `beds_allowed` (string, optional) — 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_covered` (boolean, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputMeta - `job_id` (string, required) ### V1ApplicantsRentvineApplicantIdPutOutputResult - `integration_id` (string, required) — The Propexo unique identifier for the integration - `application_template_id` (string, required) — 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 - `rent_amount_in_cents` (integer, required) — 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 - `first_name` (string, required) — The first name associated with the applicant. This field is not configurable on the Rentvine template and is always required - `last_name` (string, required) — The last name associated with the applicant. This field is not configurable on the Rentvine template and is always required - `email_1` (string, required) — The primary email address associated with the applicant. This field is not configurable on the Rentvine template and is always required - `date_of_birth` (V1ApplicantsRentvineApplicantIdPutOutputResultDateOfBirth, required) — The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required - `identification_number` (string, required) — 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 - `address_history` (list of V1ApplicantsRentvineApplicantIdPutOutputResultAddressHistoryItems, required) - `applicant_id` (string, required) — The Propexo unique identifier for the applicant - `leasing_agent_first_name` (string, optional) — 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_name` (string, optional) — 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_info` (string, optional) — 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 - `security_deposit_in_cents` (integer, optional) — 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_date` (V1ApplicantsRentvineApplicantIdPutOutputResultMoveInDate, optional) — The desired move-in date to the unit listed in the application. 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 - `lease_period_id` (string, optional) — 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 - `middle_name` (string, optional) — 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 - `type` (enum, optional) — 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: `APPLICANT`, `CO_APPLICANT`, `OCCUPANT`, `GUARANTOR` - `marital_status` (enum, optional) — 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 - Allowed values: `SINGLE`, `MARRIED`, `ENGAGED`, `SEPARATED`, `DIVORCED`, `WIDOWED`, `UNMARRIED_PARTNERS` - `maiden_name` (string, optional) — 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 - `height` (string, optional) — 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 - `weight` (string, optional) — 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_color` (string, optional) — 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_color` (string, optional) — 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` (string, optional) — Primary 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_1_type` (enum, optional) — Type of the primary phone number. An applicant can have no more than one of each phone type - Allowed values: `HOME`, `WORK`, `MOBILE` - `phone_2` (string, optional) — Secondary 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_2_type` (enum, optional) — Type of the secondary phone number. An applicant can have no more than one of each phone type. - Allowed values: `HOME`, `WORK`, `MOBILE` - `phone_3` (string, optional) — 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_type` (enum, optional) — Type of the third phone number. An applicant can have no more than one of each phone type. - Allowed values: `HOME`, `WORK`, `MOBILE` - `citizenship` (string, optional) — 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_birth` (string, optional) — 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_number` (string, optional) — 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_id` (string, optional) — 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_number` (string, optional) — 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_state` (string, optional) — 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_source` (string, optional) — 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` (list of V1ApplicantsRentvineApplicantIdPutOutputResultEmergencyContactsItems, optional) - `application_references` (list of V1ApplicantsRentvineApplicantIdPutOutputResultApplicationReferencesItems, optional) - `vehicles` (list of V1ApplicantsRentvineApplicantIdPutOutputResultVehiclesItems, optional) - `other_occupants` (list of V1ApplicantsRentvineApplicantIdPutOutputResultOtherOccupantsItems, optional) - `pets` (list of V1ApplicantsRentvineApplicantIdPutOutputResultPetsItems, optional) - `employment_history` (list of V1ApplicantsRentvineApplicantIdPutOutputResultEmploymentHistoryItems, optional) - `other_income` (list of V1ApplicantsRentvineApplicantIdPutOutputResultOtherIncomeItems, optional) - `bank_accounts` (list of V1ApplicantsRentvineApplicantIdPutOutputResultBankAccountsItems, optional) - `credit_cards` (list of V1ApplicantsRentvineApplicantIdPutOutputResultCreditCardsItems, optional) - `assistance` (V1ApplicantsRentvineApplicantIdPutOutputResultAssistance, optional) ### ErrorResponseError - `code` (string, required) - `message` (string, required) - `details` (map from string to any, optional) ### V1ApplicantsRentvineApplicantIdPutInputAddressHistoryItemsMoveInDate 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 ### V1ApplicantsRentvineApplicantIdPutInputAddressHistoryItemsMoveOutDate 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. ### V1ApplicantsRentvineApplicantIdPutInputOtherOccupantsItemsDateOfBirth 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 ### V1ApplicantsRentvineApplicantIdPutInputEmploymentHistoryItemsStartDate 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 ### V1ApplicantsRentvineApplicantIdPutInputEmploymentHistoryItemsEndDate 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultDateOfBirth The date of birth associated with the applicant. This field is not configurable on the Rentvine template and is always required ### V1ApplicantsRentvineApplicantIdPutOutputResultAddressHistoryItems - `address_1` (string, required) — The first address line associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required - `city` (string, required) — The city associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required - `state` (enum, required) — The state associated with the applicant's historical address. This field is not configurable on the Rentvine template and is always required - Allowed values: `AB`, `BC`, `MB`, `NB`, `NL`, `NT`, `NS`, `NU`, `ON`, `PE`, `QC`, `SK`, `YT`, `AL`, `AK`, `AS`, `AZ`, `AR`, `AA`, `AE`, `AP`, `CA`, `CO`, `CT`, `DE`, `DC`, `FL`, `GA`, `GU`, `HI`, `ID`, `IL`, `IN`, `IA`, `KS`, `KY`, `LA`, `ME`, `MD`, `MA`, `MI`, `MN`, `MS`, `MO`, `MT`, `NE`, `NV`, `NH`, `NJ`, `NM`, `NY`, `NC`, `ND`, `MP`, `OH`, `OK`, `OR`, `PA`, `PR`, `RI`, `SC`, `SD`, `TN`, `TX`, `UM`, `UT`, `VT`, `VI`, `VA`, `WA`, `WV`, `WI`, `WY` - `zip` (string, required) — 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 - `country` (enum, required) — 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 - Allowed values: `US`, `CA` - `address_2` (string, optional) — 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 - `address_type` (enum, optional) — 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 - Allowed values: `OWN`, `RENT` - `monthly_payment_in_cents` (integer, optional) — 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 - `move_in_date` (V1ApplicantsRentvineApplicantIdPutOutputResultAddressHistoryItemsMoveInDate, optional) — 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 - `move_out_date` (V1ApplicantsRentvineApplicantIdPutOutputResultAddressHistoryItemsMoveOutDate, optional) — 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. - `manager_name` (string, optional) — 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_phone` (string, optional) — 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 - `manager_email` (string, optional) — 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_leaving` (string, optional) — 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_type` (enum, optional) — 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 - Allowed values: `LANDLORD`, `PROPERTY_MANAGER`, `RELATIVE`, `FRIEND`, `APARTMENT` ### V1ApplicantsRentvineApplicantIdPutOutputResultMoveInDate The desired move-in date to the unit listed in the application. 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultEmergencyContactsItems - `first_name` (string, optional) — 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_name` (string, optional) — 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 - `relationship` (string, optional) — 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_1` (string, optional) — 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_2` (string, optional) — 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 - `city` (string, optional) — 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 - `state` (string, optional) — 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 - `zip` (string, optional) — 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 - `country` (string, optional) — 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_1` (string, optional) — 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 - `phone_2` (string, optional) — 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 - `email_1` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultApplicationReferencesItems - `first_name` (string, required) — The first name of the applicant's reference. This field is not configurable on the Rentvine template and is always required - `last_name` (string, required) — The last name of the applicant's reference. This field is not configurable on the Rentvine template and is always required - `relationship` (string, optional) — 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_1` (string, optional) — 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_2` (string, optional) — 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 - `city` (string, optional) — 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 - `state` (string, optional) — 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 - `zip` (string, optional) — 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 - `country` (string, optional) — 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_1` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultVehiclesItems - `make` (string, required) — The make of the vehicle. This field is not configurable on the Rentvine template and is always required - `model` (string, optional) — 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 - `year` (integer, optional) — 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 - `color` (string, optional) — 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_number` (string, optional) — 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_state` (string, optional) — 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_cents` (integer, optional) — 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 - `insurance_carrier` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultOtherOccupantsItems - `first_name` (string, required) — The first name of the occupant. This field is not configurable on the Rentvine template and is always required - `last_name` (string, required) — The last name of the occupant. This field is not configurable on the Rentvine template and is always required - `relationship` (enum, required) — 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 - Allowed values: `OTHER` - `date_of_birth` (V1ApplicantsRentvineApplicantIdPutOutputResultOtherOccupantsItemsDateOfBirth, optional) — 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 - `relationship_detail` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultPetsItems - `type` (string, required) — The type associated with the applicant pet (or breed). This field is not configurable on the Rentvine template and is always required - `name` (string, optional) — 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 - `age_in_years` (integer, optional) — 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 - `weight_in_pounds` (integer, optional) — 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 - `is_trained` (boolean, optional) — 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 - `color` (string, optional) — 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 - `gender` (enum, optional) — 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 - Allowed values: `MALE`, `FEMALE`, `UNSPECIFIED` - `is_declawed` (boolean, optional) — 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_vaccinated` (boolean, optional) — 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_fixed` (boolean, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultEmploymentHistoryItems - `is_current_employer` (boolean, required) — Whether this employment history entry is for a current employer. This field is not configurable on the Rentvine template and is always required - `name` (string, required) — The name of the employer. This field is not configurable on the Rentvine template and is always required - `phone` (string, optional) — 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 - `address_1` (string, optional) — 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_2` (string, optional) — 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 - `city` (string, optional) — 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 - `state` (string, optional) — 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 - `zip` (string, optional) — 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 - `country` (string, optional) — 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_name` (string, optional) — 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_name` (string, optional) — 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_title` (string, optional) — 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_phone` (string, optional) — 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 - `supervisor_email` (string, optional) — 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 - `position` (string, optional) — 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 - `income_in_cents` (integer, optional) — The monthly income of the applicant at this employer in cents. This field is not configurable on the Rentvine template and is always required - `start_date` (V1ApplicantsRentvineApplicantIdPutOutputResultEmploymentHistoryItemsStartDate, optional) — 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 - `end_date` (V1ApplicantsRentvineApplicantIdPutOutputResultEmploymentHistoryItemsEndDate, optional) — 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 - `monthly_income_in_cents` (integer, optional, deprecated) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultOtherIncomeItems - `source` (string, required) — The source of the income for the applicant. This field is not configurable on the Rentvine template and is always required - `monthly_income_in_cents` (integer, required) — The monthly income from this income source in cents. This field is not configurable on the Rentvine template and is always required - `phone` (string, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultBankAccountsItems - `name` (string, required) — The name of the bank where the account is held. This field is not configurable on the Rentvine template and is always required - `account_type` (enum, optional) — 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 - Allowed values: `SAVINGS`, `CHECKING` - `account_number` (string, optional) — 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_cents` (integer, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultCreditCardsItems - `name` (string, required) — 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_cents` (integer, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultAssistance - `agency_name` (string, optional) — 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 - `county` (string, optional) — 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_name` (string, optional) — 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 - `phone` (string, optional) — 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 - `assistance_amount_in_cents` (integer, optional) — 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 - `beds_allowed` (string, optional) — 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_covered` (boolean, optional) — 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultAddressHistoryItemsMoveInDate 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultAddressHistoryItemsMoveOutDate 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. ### V1ApplicantsRentvineApplicantIdPutOutputResultOtherOccupantsItemsDateOfBirth 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultEmploymentHistoryItemsStartDate 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 ### V1ApplicantsRentvineApplicantIdPutOutputResultEmploymentHistoryItemsEndDate 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 ## Examples **Request** ```json { "integration_id": "int-987654321", "application_template_id": "tmpl-123456789", "rent_amount_in_cents": 150000, "first_name": "Emily", "last_name": "Johnson", "email_1": "emily.johnson@example.com", "date_of_birth": "1990-05-20", "identification_number": "123-45-6789", "address_history": [ { "address_1": "123 Maple Street", "city": "Calgary", "state": "AB", "zip": "T2P 1J9", "country": "CA" } ] } ``` **Response** ```json { "meta": { "job_id": "job-20240615-001" }, "result": { "integration_id": "int-987654321", "application_template_id": "tmpl-123456789", "rent_amount_in_cents": 150000, "first_name": "Emily", "last_name": "Johnson", "email_1": "emily.johnson@example.com", "date_of_birth": "1990-05-20", "identification_number": "123-45-6789", "address_history": [ { "address_1": "123 Maple Street", "city": "Calgary", "state": "AB", "zip": "T2P 1J9", "country": "CA", "address_2": "Unit 5", "address_type": "RENT", "monthly_payment_in_cents": 140000, "move_in_date": "2020-06-01", "move_out_date": "2024-06-15", "manager_name": "Laura Smith", "manager_phone": "+14035550777", "manager_email": "laura.smith@propertymgmt.com", "reason_for_leaving": "Relocating for work", "manager_type": "PROPERTY_MANAGER" } ], "applicant_id": "app-123456789", "leasing_agent_first_name": "Sarah", "leasing_agent_last_name": "Miller", "leasing_agent_contact_info": "sarah.miller@leasingco.com, +1-403-555-0199", "security_deposit_in_cents": 150000, "move_in_date": "2024-07-01", "lease_period_id": "lease-12months", "middle_name": "Grace", "type": "APPLICANT", "marital_status": "SINGLE", "maiden_name": "Smith", "height": "5ft 6in", "weight": "135 lbs", "eye_color": "Green", "hair_color": "Brown", "phone_1": "+14035550123", "phone_1_type": "MOBILE", "phone_2": "+14035550124", "phone_2_type": "WORK", "phone_3": "+14035550125", "phone_3_type": "HOME", "citizenship": "Canada", "place_of_birth": "Calgary, Alberta", "passport_number": "X1234567", "student_id": "S123456789", "drivers_license_number": "D1234567", "drivers_license_state": "AB", "lead_source": "Online Listing", "emergency_contacts": [ { "first_name": "Michael", "last_name": "Johnson", "relationship": "Brother", "address_1": "456 Oak Avenue", "address_2": "Apt 2B", "city": "Calgary", "state": "AB", "zip": "T2P 2K3", "country": "CA", "phone_1": "+14035550987", "phone_2": "+14035550988", "email_1": "michael.johnson@example.com" } ], "application_references": [ { "first_name": "Laura", "last_name": "Smith", "relationship": "Former Landlord", "address_1": "789 Pine Street", "address_2": "", "city": "Calgary", "state": "AB", "zip": "T2P 3L4", "country": "CA", "phone_1": "+14035550777" } ], "vehicles": [ { "make": "Toyota", "model": "Camry", "year": 2018, "color": "Silver", "license_plate_number": "ABC1234", "license_plate_state": "AB", "monthly_payment_in_cents": 35000, "insurance_carrier": "Allianz" } ], "other_occupants": [ { "first_name": "Sophia", "last_name": "Johnson", "relationship": "OTHER", "date_of_birth": "2012-08-15", "relationship_detail": "Daughter" } ], "pets": [ { "type": "Golden Retriever", "name": "Buddy", "age_in_years": 3, "weight_in_pounds": 65, "is_trained": true, "color": "Golden", "gender": "MALE", "is_declawed": false, "is_vaccinated": true, "is_fixed": true } ], "employment_history": [ { "is_current_employer": true, "name": "Tech Solutions Inc.", "phone": "+14035551234", "address_1": "100 Innovation Drive", "address_2": "Suite 200", "city": "Calgary", "state": "AB", "zip": "T2P 4K7", "country": "CA", "supervisor_first_name": "James", "supervisor_last_name": "Anderson", "supervisor_title": "Manager", "supervisor_phone": "+14035551235", "supervisor_email": "james.anderson@techsolutions.com", "position": "Software Engineer", "income_in_cents": 800000, "start_date": "2018-09-01", "end_date": "", "monthly_income_in_cents": 800000 } ], "other_income": [ { "source": "Freelance Consulting", "monthly_income_in_cents": 200000, "phone": "+14035551333" } ], "bank_accounts": [ { "name": "First National Bank", "account_type": "CHECKING", "account_number": "1234567890", "balance_in_cents": 2500000 } ], "credit_cards": [ { "name": "Visa Platinum", "balance_in_cents": 50000 } ], "assistance": { "agency_name": "City Housing Assistance", "county": "Calgary County", "technician_name": "Anna Lee", "phone": "+14035551444", "assistance_amount_in_cents": 100000, "beds_allowed": "2", "are_utilities_covered": false } } } ``` **SDK Code** ```python import requests url = "https://api.propexo.com/v1/applicants/rentvine/applicant_id" payload = { "integration_id": "int-987654321", "application_template_id": "tmpl-123456789", "rent_amount_in_cents": 150000, "first_name": "Emily", "last_name": "Johnson", "email_1": "emily.johnson@example.com", "date_of_birth": "1990-05-20", "identification_number": "123-45-6789", "address_history": [ { "address_1": "123 Maple Street", "city": "Calgary", "state": "AB", "zip": "T2P 1J9", "country": "CA" } ] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.propexo.com/v1/applicants/rentvine/applicant_id'; const options = { method: 'PUT', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"integration_id":"int-987654321","application_template_id":"tmpl-123456789","rent_amount_in_cents":150000,"first_name":"Emily","last_name":"Johnson","email_1":"emily.johnson@example.com","date_of_birth":"1990-05-20","identification_number":"123-45-6789","address_history":[{"address_1":"123 Maple Street","city":"Calgary","state":"AB","zip":"T2P 1J9","country":"CA"}]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.propexo.com/v1/applicants/rentvine/applicant_id" payload := strings.NewReader("{\n \"integration_id\": \"int-987654321\",\n \"application_template_id\": \"tmpl-123456789\",\n \"rent_amount_in_cents\": 150000,\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\",\n \"email_1\": \"emily.johnson@example.com\",\n \"date_of_birth\": \"1990-05-20\",\n \"identification_number\": \"123-45-6789\",\n \"address_history\": [\n {\n \"address_1\": \"123 Maple Street\",\n \"city\": \"Calgary\",\n \"state\": \"AB\",\n \"zip\": \"T2P 1J9\",\n \"country\": \"CA\"\n }\n ]\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.propexo.com/v1/applicants/rentvine/applicant_id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"integration_id\": \"int-987654321\",\n \"application_template_id\": \"tmpl-123456789\",\n \"rent_amount_in_cents\": 150000,\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\",\n \"email_1\": \"emily.johnson@example.com\",\n \"date_of_birth\": \"1990-05-20\",\n \"identification_number\": \"123-45-6789\",\n \"address_history\": [\n {\n \"address_1\": \"123 Maple Street\",\n \"city\": \"Calgary\",\n \"state\": \"AB\",\n \"zip\": \"T2P 1J9\",\n \"country\": \"CA\"\n }\n ]\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://api.propexo.com/v1/applicants/rentvine/applicant_id") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"integration_id\": \"int-987654321\",\n \"application_template_id\": \"tmpl-123456789\",\n \"rent_amount_in_cents\": 150000,\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\",\n \"email_1\": \"emily.johnson@example.com\",\n \"date_of_birth\": \"1990-05-20\",\n \"identification_number\": \"123-45-6789\",\n \"address_history\": [\n {\n \"address_1\": \"123 Maple Street\",\n \"city\": \"Calgary\",\n \"state\": \"AB\",\n \"zip\": \"T2P 1J9\",\n \"country\": \"CA\"\n }\n ]\n}") .asString(); ``` ```php request('PUT', 'https://api.propexo.com/v1/applicants/rentvine/applicant_id', [ 'body' => '{ "integration_id": "int-987654321", "application_template_id": "tmpl-123456789", "rent_amount_in_cents": 150000, "first_name": "Emily", "last_name": "Johnson", "email_1": "emily.johnson@example.com", "date_of_birth": "1990-05-20", "identification_number": "123-45-6789", "address_history": [ { "address_1": "123 Maple Street", "city": "Calgary", "state": "AB", "zip": "T2P 1J9", "country": "CA" } ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.propexo.com/v1/applicants/rentvine/applicant_id"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"integration_id\": \"int-987654321\",\n \"application_template_id\": \"tmpl-123456789\",\n \"rent_amount_in_cents\": 150000,\n \"first_name\": \"Emily\",\n \"last_name\": \"Johnson\",\n \"email_1\": \"emily.johnson@example.com\",\n \"date_of_birth\": \"1990-05-20\",\n \"identification_number\": \"123-45-6789\",\n \"address_history\": [\n {\n \"address_1\": \"123 Maple Street\",\n \"city\": \"Calgary\",\n \"state\": \"AB\",\n \"zip\": \"T2P 1J9\",\n \"country\": \"CA\"\n }\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "integration_id": "int-987654321", "application_template_id": "tmpl-123456789", "rent_amount_in_cents": 150000, "first_name": "Emily", "last_name": "Johnson", "email_1": "emily.johnson@example.com", "date_of_birth": "1990-05-20", "identification_number": "123-45-6789", "address_history": [ [ "address_1": "123 Maple Street", "city": "Calgary", "state": "AB", "zip": "T2P 1J9", "country": "CA" ] ] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.propexo.com/v1/applicants/rentvine/applicant_id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```