POST Request Parameters
| Parameter | Description | Usage |
|---|---|---|
| address | The address to be searched. | Optional |
| objectId | Uniquely identifies addresses. If provided, the associated objectId with each address is returned in the response for reference. It should be a valid positive integer. If not provided, then the objectId is generated starting '1' and auto incremented. | Optional |
| mainAddressLine | Input address. | Optional |
| addressLastLine | Last line of the address. | Optional |
| placeName | Building name, place name, Point of Interest (POI), company or firm name associated with the input address. | Optional |
| areaName1 | Specifies the largest geographic area, typically a state or province. | Optional |
| areaName2 | Specifies the secondary geographic area, typically a county or district. | Optional |
| areaName3 | Specifies a city or town name. | Optional |
| areaName4 | Specifies a city subdivision or locality. | Optional |
| postCode | The postal code in the appropriate format for the country. | Optional |
| postCodeExt | Postal code extension. | Optional |
| country | ISO 3166-1 alpha-3 country code. Supported country: USA |
Optional |
| addressNumber | House or building number. | Optional |
| streetName | Street name of the input address. | Optional |
| unitType | Specifies the type of unit, such as Apt., Ste. and Bldg. | Optional |
| unitValue | Specifies the unit value/number, such as "3B". | Optional |
| preferences object contains the following elements: | ||
| includeGeometry | Specifies whether or not to include the geometry. If 'Y' is specified flood zone
boundary will be shown in response. If 'N' is specified , the flood
zone boundary will not be shown in response. Possible values: Y or N Default: 'N' |
Optional |
| includeZoneDesc | Specifies primary zone description. Valid Values: 'Y' or 'N' Default: 'Y' If the specified value is 'N', the primary zone description is not returned in the response. |
Optional |