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.

Applicants API

Applicants applying together are grouped in an Application.

GET

/api/v2/applications/:application_id/applicants/:applicant_id

Returns an Applicant object. This endpoint is frequently called after receiving an application_form.completed webhook to pull the applicant data from the system.

Example Response

{
  "applicant": {
    "id": 383424,
    "type": "roommate",
    "application": {
      "id": 193826,
      "property_id": 11309,
      "api_url": "https://quickleasepro.com/api/v2/applications/193826"
    },
    "first_name": "Tiff",
    "last_name": "Tiffany",
    "middle_name": "T",
    "id_number": "111223333",
    "dob": "1970-01-01",
    "dl_state": "DC",
    "dl_number": "123456",
    "email": "test@example.com",
    "phone": "1234567890",
    "currently_unemployed": false,
    "background_order_number": 11234,
    "background_ordered_at": "2015-08-31T20:06:16-06:00",
    "background_error": null,
    "background_report_decision": "-",
    "reference_id": null,
    "created_at": "2015-08-31T19:23:40-06:00",
    "updated_at": "2015-08-31T20:06:16-06:00",
    "custom_data": {
      "other": {
        "judgement": {
          "answer": "No",
          "prompt_reason": ""
        },
        "bankruptcy": {
          "answer": "No",
          "prompt_reason": ""
        },
        "refused_rent": {
          "answer": "No",
          "prompt_reason": ""
        },
        "evicted": {
          "answer": "No",
          "prompt_reason": ""
        },
        "convicted": {
          "answer": "No",
          "prompt_reason": ""
        },
        "lost_deposit": {
          "answer": "No",
          "prompt_reason": ""
        },
        "mortgage": {
          "answer": "No",
          "prompt_reason": ""
        },
        "credit": {
          "answer": "No",
          "prompt_reason": ""
        },
        "custom_1": {
          "answer": "No",
          "prompt_reason": ""
        },
        "waterbed": {
          "answer": "No"
        },
        "aquarium": {
          "answer": "No"
        },
        "smoke": {
          "answer": "No"
        }
      }
    },
    "current_address": {
      "id": 558333,
      "applicant_id": 383424,
      "kind": "rent",
      "payment": 1050,
      "street": "6654 Yale, St, NW",
      "street2": null,
      "city": "WASHINGTON",
      "state": "DC",
      "zip": "20009",
      "country_code": "US",
      "reason_for_moving": "would like a nicer/more updated place",
      "date_start": "2012-02-01",
      "date_end": null,
      "do_not_contact": true,
      "landlord_name": "Tom Papsidero",
      "landlord_phone": "3012376633",
      "landlord_fax": "",
      "landlord_email": "text@example.com",
      "custom_data": {},
      "created_at": "2015-08-31T19:43:22-06:00",
      "updated_at": "2015-08-31T19:43:22-06:00"
    },
    "previous_addresses": [
      {
        "id": 558334,
        "applicant_id": 383424,
        "kind": "rent",
        "payment": 950,
        "street": "42251 33rd St, NW",
        "street2": null,
        "city": "Washington",
        "state": "DC",
        "zip": "20007",
        "country_code": "US",
        "reason_for_moving": "to be closer to work",
        "date_start": "2010-10-01",
        "date_end": "2011-11-01",
        "do_not_contact": null,
        "landlord_name": "Jamie MacAyeal",
        "landlord_phone": "2026168777",
        "landlord_fax": "",
        "landlord_email": "test@example.com",
        "custom_data": {},
        "created_at": "2015-08-31T19:43:22-06:00",
        "updated_at": "2015-08-31T19:43:22-06:00"
      }
    ],
    "current_employers": [
      {
        "id": 335919,
        "applicant_id": 383424,
        "kind": "part_time",
        "self_employed": false,
        "verify_employer": true,
        "name": "SoulCycle Inc",
        "street": "2301 M St, NW",
        "street2": null,
        "city": "WASHINGTON",
        "state": "DC",
        "zip": "20037",
        "country_code": "US",
        "position": "Sales",
        "income": 15000,
        "income_unit": "per_year",
        "reason_for_leaving": null,
        "supervisor_phone": "2026597685",
        "supervisor_name": "Brittney Posternock",
        "supervisor_fax": "2026597685",
        "supervisor_email": "brittney.posternock@soul-cycle.com",
        "date_start": "2014-12-01",
        "date_end": null,
        "custom_data": {},
        "created_at": "2015-08-31T19:52:02-06:00",
        "updated_at": "2015-08-31T19:52:02-06:00"
      }
    ],
    "previous_employers": [
      {
        "id": 335920,
        "applicant_id": 383424,
        "kind": "full_time",
        "self_employed": false,
        "verify_employer": true,
        "name": "MedStar Health Research Institute",
        "street": "6525 Belcrest Road #7000",
        "street2": null,
        "city": "Hyattsville ",
        "state": "MD",
        "zip": "20782",
        "country_code": "US",
        "position": "Research Associate",
        "income": 48000,
        "income_unit": "per_year",
        "reason_for_leaving": null,
        "supervisor_phone": "2028771875",
        "supervisor_name": "Rahsaan Holley",
        "supervisor_fax": "2027267521",
        "supervisor_email": "",
        "date_start": "2010-09-01",
        "date_end": "2014-08-01",
        "custom_data": {},
        "created_at": "2015-08-31T19:52:02-06:00",
        "updated_at": "2015-08-31T19:52:02-06:00"
      }
    ],
    "other_incomes": [
      {
        "id": 57740,
        "applicant_id": 383424,
        "source": "student loans (full-time nursing student)",
        "amount": 2100,
        "custom_data": {},
        "created_at": "2015-08-31T19:52:02-06:00",
        "updated_at": "2015-08-31T19:52:02-06:00"
      }
    ],
    "pets": [
      {
        "id": 62427,
        "applicant_id": 383424,
        "kind": "American short-haired cat",
        "name": null,
        "coloration": "tabby",
        "age": "7",
        "weight": 8,
        "sex": "female",
        "fixed": true,
        "declawed": null,
        "custom_data": {},
        "created_at": "2015-08-31T19:53:20-06:00",
        "updated_at": "2015-08-31T19:53:20-06:00"
      }
    ],
    "vehicles": [],
    "bank_account": {
      "id": 75921,
      "applicant_id": 383424,
      "name": "USAA Federal Savings Bank",
      "account": "Checking",
      "phone": "2105318722",
      "custom_data": {},
      "created_at": "2015-08-31T19:55:57-06:00",
      "updated_at": "2015-08-31T19:55:57-06:00"
    },
    "references": [],
    "emergency_contacts": [
      {
        "id": 230152,
        "applicant_id": 383424,
        "name": "Debra Tiffany",
        "relationship": "mother",
        "phone": "1234567890",
        "email": "test@example.com",
        "street": null,
        "street2": null,
        "city": null,
        "state": null,
        "zip": null,
        "country_code": "US",
        "custom_data": {},
        "created_at": "2015-08-31T19:55:57-06:00",
        "updated_at": "2015-08-31T19:55:57-06:00"
      }
    ]
  }
}

GET

/api/v2/applications/:application_id/applicants/:applicant_id/invite_url

Returns a unique URL to launch the online application form for the specified applicant. The URL is valid for 3 days. You need to create an application or an applicant before you can generate an invite URL.

Example Response

{
  "apply_url": "http://glacier.qlp.dev/d/invite/820a5fd35cc2f836449d088084",
  "passcode": "380215851"
}

You can typically ignore the passcode unless you are doing invitation only properties.

GET

/api/v2/applications/:application_id/applicants/:applicant_id/background_report_url

Returns a temporary pre-authenticated URL that pulls up the HTML report straight from the screening platform.

The link is valid for 1 minute, and since it does not require API credentials to access, you can redirect users to it.

Keep in mind the report is actually available almost immediately after the background check is ordered. But, you might not want to pull it up until you receive the webhook letting you know the background check is complete to ensure you pull a complete report.

Example Response

{
  "url": "https://quickleasepro.com/api/v2/fetch/background_report/e7rhfd"
}

Example Error

{
  "error":
  {
    "message": "The report is not available yet",
    "details": null
  }
}

You can typically ignore the passcode unless you are doing invitation only properties.