Skip to main content

​
Address (AddressDto)

Each entry in applicant.addresses is an AddressDto merged with address residency dates.

​
Supported Fields

FieldRequiredTypeRules and behavior
addressTypeYesstringAddress category, such as home, work, or mailing.
addressLine1YesstringStreet line 1.
addressLine2NostringApartment, suite, unit, or other secondary line.
addressCityYesstringCity.
addressStateYesstringTwo-letter US state code.
addressZipCodeYesstringZIP or postal code. Length 1–10.
addressCountryNostringTwo-letter country code. Defaults to US when omitted.
startDateYesstringStart of residence in YYYY-MM-DD format.
endDateNostring or nullEnd of residence in YYYY-MM-DD format. Use null or omit for the current address. Exactly one address in a non-empty list should be current.

​
Example

{
  "addressType": "home",
  "addressLine1": "456 Oak Avenue",
  "addressLine2": null,
  "addressCity": "Los Angeles",
  "addressState": "CA",
  "addressZipCode": "90210",
  "addressCountry": "US",
  "startDate": "2021-01-01",
  "endDate": null
}