Address
Residence address entry used inapplicant.addresses.
Fields
| Field | Required | Type | Description | |
|---|---|---|---|---|
addressType | Yes | string | Address category, such as home, work, or mailing. | |
addressLine1 | Yes | string | Street line 1. | |
addressLine2 | No | string | Apartment, suite, unit, or other secondary line. | |
addressCity | Yes | string | City. | |
addressState | Yes | string | Two-letter US state code. | |
addressZipCode | Yes | string | ZIP or postal code. Length 1–10. | |
addressCountry | No | string | Two-letter country code. Defaults to US when omitted. | |
startDate | Yes | string | Start of residence in YYYY-MM-DD format. | |
endDate | No | `string | null` | End 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
}