RentProfile API documentation

Create Tenancy API Request Data Param Types

{
    api_key : [string],
    branch_id : [string],
    branch_name : [string],
    address_line1 : [string],
    town : [string],
    city : [string],
    postcode : [string],
    combined : [string],
    total_rent : [string],
    rent_per_person : [string],
    aml_required : [string],
    deposit : [string],
    holding_deposit : [string],
    tenancy_start_date : [string],
    tenancy_term_months : [string],
    landlord_name : [string],
    landlord_email : [string],
    landlord_home_address_line1 : [string],
    landlord_home_address_postcode : [string],
    deposit_amount : [string],
    holding_deposit_external : [string],
    holding_deposit_amount : [string],
    deposit_scheme : [string],
    deposit_type : [string],
    deposit_auto_registration : [string],
    deposit_held_by : [string],
    deposit_replacement : [string],
    deposit_replacement_only : [string],
    payment_ref : [string],
    is_standing_order_required : [string],
    rent_free_amount : [string],
    rent_free_deducted_from : [string],
    rent_payment_frequency : [string],
    rent_due_date : [string],
    rent_amount_period : [string],
    has_rent_increase : [string],
    rent_increase_amount : [string],
    rent_increase_type : [string],
    tenancy_end_date : [string],
    default_custom_clause : [string],
    additional_custom_clause : [string],
    landlord_break_clause_months : [string],
    landlord_break_clause_date : [string],
    landlord_break_clause_annually : [string],
    landlord_break_clause_before_after : [string],                                     
    tenant_break_clause_months : [string],
    tenant_break_clause_date : [string],
    tenant_break_clause_annually : [string],
    tenant_break_clause_before_after : [string],
    landlord_home_address_town : [string],
    landlord_home_address_city : [string],
    landlord_name_2 : [string],
    landlord_email_2 : [string],
    landlord_home_address_line1_2 : [string],
    landlord_home_address_postcode_2 : [string],
    landlord_home_address_town_2 : [string],
    landlord_home_address_city_2 : [string],
    landlord_as_signatory : [string],
    agent_to_sign_on_behalf_of_landlord : [string],
    let_only : [string],
    let_only_bankholders_name : [string],
    let_only_account_number : [string],
    let_only_sort_code : [string],
    renewal : [string],
    garden : [string],
    garage : [string],
    parking_space : [string],
    parking_space_description : [string],
    storage_space : [string],
    storage_space_description : [string],
    pets : [string],
    pets_description : [string],
    smoking : [string],
    gas : [string],
    council_tax_included : [string],
    tv_licence_included : [string],
    gas_bill_included : [string],
    water_bill_included : [string],
    electricity_bill_included : [string],
    phone_bill_included : [string],
    broadband_bill_included : [string],
    applicant_name : [string],
    applicant_email : [string],
    applicant_mobile : [string],
    applicant_months_upfront : [string],
    applicant_name_2 : [string],
    applicant_email_2 : [string],
    applicant_mobile_2 : [string],
    applicant_is_guarantor_for_2 : [string],
    applicant_months_upfront_2 : [string],
    applicant_name_3 : [string],
    applicant_email_3 : [string],
    applicant_mobile_3 : [string],
    applicant_is_guarantor_for_3 : [string],
    applicant_months_upfront_3 : [string],
    applicant_name_4 : [string],
    applicant_email_4 : [string],
    applicant_mobile_4 : [string],
    applicant_is_guarantor_for_4 : [string],
    applicant_months_upfront_4 : [string],
    applicant_name_5 : [string],
    applicant_email_5 : [string],
    applicant_mobile_5 : [string],
    applicant_is_guarantor_for_5 : [string],
    applicant_months_upfront_5 : [string],
    applicant_name_6 : [string],
    applicant_email_6 : [string],
    applicant_mobile_6 : [string],
    applicant_is_guarantor_for_6 : [string],
    applicant_months_upfront_6 : [string],
    applicant_name_7 : [string],
    applicant_email_7 : [string],
    applicant_mobile_7 : [string],
    applicant_is_guarantor_for_7 : [string],
    applicant_months_upfront_7 : [string],
    applicant_name_8 : [string],
    applicant_email_8 : [string],
    applicant_mobile_8 : [string],
    applicant_is_guarantor_for_8 : [string],
    applicant_months_upfront_8 : [string],
    applicant_name_9 : [string],
    applicant_email_9 : [string],
    applicant_mobile_9 : [string],
    applicant_is_guarantor_for_9 : [string],
    applicant_months_upfront_9 : [string],
    applicant_name_10 : [string],
    applicant_email_10 : [string],
    applicant_mobile_10 : [string],
    applicant_is_guarantor_for_10 : [string],
    applicant_months_upfront_10 : [string],
    permitted_occupier_name_1 : [string],
    permitted_occupier_email_1 : [string],
    permitted_occupier_mobile_1 : [string],
    permitted_occupier_1_over18 : [string],
    permitted_occupier_name_2 : [string],
    permitted_occupier_email_2 : [string],
    permitted_occupier_mobile_2 : [string],
    permitted_occupier_2_over18 : [string],
    permitted_occupier_name_3 : [string],
    permitted_occupier_email_3 : [string],
    permitted_occupier_mobile_3 : [string],
    permitted_occupier_3_over18 : [string],
    client_name : [string],
    client_type : [string],
    client_email : [string],
    client_phone : [string]
}

Valid deposit_scheme permitted values are "tds", "mydeposits" and "dps".

Valid deposit_replacement permitted values are "reposit", "flatfair" and "zerodeposit".

Valid rent_payment_frequency permitted values are "weekly", "monthly" and "annually" (if no permitted rent_payment_frequency value is provided, monthly will be set by default).

Valid rent_increase_type permitted values are "£" and "%".

Valid rent_free_deducted_from permitted values are "1"and "2" for indicicating whether the rent free amount will be deducted from the 1st or 2nd rental payment (this only applies if the rent_free_amount is provided).

Create Tenancy API Request Data Params Example

{
    "api_key":"longrandomstringforapikey123456",
    "branch_id":"71",
    "address_line1":"32 London Bridge Street",
    "city":"London",
    "postcode":"SE1 9SG",
    "combined":"true",
    "total_rent":"£2000",
    "deposit":"true",
    "deposit_amount":"£500",
    "deposit_scheme":"tds"
    "deposit_type":"custodial",
    "deposit_auto_registration":"true",
    "holding_deposit":"true",
    "holding_deposit_amount":"£100",
    "tenancy_start_date":"18-07-2021",
    "tenancy_term_months":"12",
    "default_custom_clause":"true",
    "additional_custom_clause":"2. The Tenants agree to water the plants in the hallway at least once a week.\n3. The Tenants agree to use the recycling bins where applicable.",
    "landlord_name":"Michael Thompson",
    "landlord_email":"example@landlord.com",
    "landlord_home_address_line1":"10 Moseley Road",
    "landlord_home_address_town":"Hallow",
    "landlord_home_address_city":"Worcester",
    "landlord_home_address_postcode":"WR2 6NJ",
    "applicant_name":"Anna Stevens",
    "applicant_email":"example@renter.com",
    "applicant_mobile":"07123456789",
    "applicant_name_2":"Tom Smith",
    "applicant_email_2":"example2@renter.com",
    "applicant_name_3":"Jane Smith",
    "applicant_email_3":"example@guarantor.com",
    "applicant_mobile_3":"07987654321",
    "applicant_is_guarantor_for_3":"Tom Smith"
}

The first applicant will be set as the lead tenant, in this example the lead tenant is Anna Stevens.

The default custom clause is the same default clauses which display when creating a tenancy via the Onboarding in the agent dashboard (if you do not wish to include this text do not set default_clause as "true"). To provide custom clauses besides the default (added after the default_clause if set as "true") use the additional_custom_clause param.
A line break should be used between each clause number using "/n" as shown in the example above.

Create Tenancy API Response Data Param Types

{
    tenancy_id : [string],
    applicant_name : [string],
    request_id : [string],
    applicant_name_2 : [string],
    request_id_2 : [string],
    applicant_name_3 : [string],
    request_id_3 : [string],
    applicant_name_4 : [string],
    request_id_4 : [string],
    applicant_name_5 : [string],
    request_id_5 : [string],
    applicant_name_6 : [string],
    request_id_6 : [string],
    applicant_name_7 : [string],
    request_id_7 : [string],
    applicant_name_8 : [string],
    request_id_8 : [string],
    applicant_name_9 : [string],
    request_id_9 : [string],
    applicant_name_10 : [string],
    request_id_10 : [string]
}

Create Tenancy API Response Data Params Example

{
   "tenancy_id":"78e58eea6c5549adeb8e50d7c406572de549cc7b6c9bd48d4af1e2b627f4",
   "applicant_name":"Anna Stevens",
   "request_id":"3d51225d80",
   "applicant_name_2":"Tom Smith",
   "request_id_2":"837y4uie34",
   "applicant_name_3":"Jane Smith",
   "request_id_3":"d4jvrow237"
}

Multiple Request ID's (request_id, request_id_2, request_id_3 etc.) will be in the response if multiple applicants are submitted at the same time.