For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Indicates whether the customer is the head of household
relationshipenumOptional
Relationship of the customer to the head of household (null for head of household)
passportNumberLastFourstring or nullOptional
Last 4 characters of the passport number, spaces and dashes removed. null when no passport number is on file or it has 4 characters or fewer. The full number is never returned.
passportCountrystring or nullOptional
Name of the country that issued the passport (for example “United States”). null when no passport country is on file.
alienRegistrationNumberLastFourstring or nullOptional
Last 4 characters of the alien registration number (A-Number), spaces and dashes removed. null when no number is on file or it has 4 characters or fewer. The full number is never returned.
citizenshipStatusstring or nullOptional
HUD member citizenship code from the affordable certification: EC (citizen or national), EN (non-citizen with eligible immigration status), IC (ineligible non-citizen child of head or spouse), IN (ineligible non-citizen), IP (ineligible parent of head or spouse), ND (no documentation submitted), PV (eligibility pending verification), XX (not a family member, for example a foster). Only records on certifications that are not deleted count; when the applicant has more than one, the most recently updated one is used. null when none is recorded.
maritalStatusstring or nullOptional
Marital status from the rental application as stored, for example single, married, divorced, separated or widowed. null when not answered.
spouseNamestring or nullOptional
Spouse full name from the rental application (first, middle and last name). null when no spouse is recorded.
studentTypestring or nullOptional
Student type code from the rental application: f_tK_12 (full-time, kindergarten to grade 12), f_tPost12 (full-time, after grade 12) or p_t (part-time); a few older applications hold free text such as Full-time or Part-Time. Returned as stored, even when the application does not mark the customer as a student. null when the answer is not a student (n_s, Not a student or No es estudiante) or the question was not answered.
currentAddressStreetstring or nullOptional
First street line of the current address the customer gave on the rental application. null when no current address is on file or the line is blank.
currentAddressStreet2string or nullOptional
Second street line (apartment, suite, unit) of the current address from the rental application. null when blank or no current address is on file.
currentAddressCitystring or nullOptional
City of the current address from the rental application. null when blank or no current address is on file.
currentAddressStatestring or nullOptional
Two-letter state or territory code of the current address from the rental application (for example “NY”). null when no state is on file or the stored value is not a known state or territory code.
currentAddressZipCodestring or nullOptional
ZIP code of the current address from the rental application, as entered. null when blank or no current address is on file.
lenderNamestring or nullOptional
Name of the landlord or mortgage lender for the current address, as entered on the rental application. null when blank or no current address is on file.
