Warning: Only resources, actions, and attributes documented here should be considered public. Any undocumented resources, actions, or attributes should be considred private and may change at any time without notice. Be extra cautious of undocumented attributes since those are the most likely to change.

If you with to use a undocumented portion of the API, please contact us first so we can either a) document it and make it public or b) explain what planned changes are in store for that part of the API.

Applications API

Applications represent a group of Applicants who are applying together as co-applicants.

POST

/api/v2/applications

Creates both a new Application and an Applicant.

property_id integer, required	The `id` of the property the applicant is applying to.
user_specified_rent integer, optional	If the property the applicant is applying to doesn't specify a rent amount you can pass one in here. The value is passed to the screening platform for income to rent calculations. Example: 1250.
desired_move_in date, optional	The date the applicant would like to move in. This is not the actual move in date, only the desired move in date. Example: 01/12/2018
assigned_user_id integer, optional	The `id` of the user you want the application assigned to. Example: 12.
applicant.first_name string, required	Example: John
applicant.last_name string, required	Example: Doe
applicant.email string, required	Example: test@example.com
applicant.dob date, optional	The date of birth of the applicant. Example: 04/05/1991
applicant.id_number string, optional	The goverment issued ID number. Currently only supports US social security number.
applicant.phone string, optional	The primary phone number of the applicant. Example: 8011234567
applicant.custom_data map, optional	Any custom data structure.
applicant.reference_id string, optional	Integrator id for the applicant.
applicant.redirect_url string, optional	If you provide a URL, the system will redirect the applicant to this URL instead of displaying the normal confirmation page.

Example Request

{
  "application": {
    "property_id": 22,
    "user_specified_rent": 1250,
    "assigned_user_id": 12,
    "applicant": {
      "first_name": "George",
      "last_name": "Burns",
      "email": "gb@example.com",
      "redirect_url": "https://example.com/whatever",
      "reference_id": null
    }
  }
}

Example Response

{
  "application": {
    "id": 2729,
    "property_id": 22,
    "client_id": 1,
    "assigned_user_id": 12,
    "floor_plan_id": null,
    "desired_unit_description": null,
    "desired_lease_length": null,
    "desired_unit_number": null,
    "user_specified_rent": 1250,
    "desired_move_in": null,
    "showing_agent": null,
    "showing_agent_id": null,
    "referral": null,
    "archived": null,
    "created_at": "2015-11-10T14:06:32-07:00",
    "updated_at": "2015-11-10T14:06:32-07:00",
    "property": {
      "id": 22,
      "name": "Test Property"
    },
    "applicants": [{
      "id": 4621,
      "type": "primary",
      "name": "George Burns",
      "api_url": "http://qlp.dev/api/v2/applications/2729/applicants/4621"
      }
    ]
  }
}

Example Error

{
  "error": {
    "message": "property_id is invalid or cannot be found",
    "details": null
  }
}