POST Request Parameters
- addressTime - Request object which takes the following attributes. Required.
- preferences - The option to set preferences.
Optional.
These objects and their elements are defined in the following table:
| Parameter | Description | Usage |
|---|---|---|
| objectId | Uniquely identifies address. 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 |
| timestamp | Specifies UTC time in milliseconds. The value is time elapsed since January 1, 1970 UTC. The input can contain negative and positive values, where the positive values express time after January 1, 1970 UTC, and negative values express time before January 1, 1970 UTC. | Required |
| matchMode |
Exact Requires exact match. This mode generates the fewest match candidates, which decreases the processing time. When using this mode, ensure that your input is accurate with correct spellings and complete addresses. Standard (Default value) Requires a close match and generates a moderate number of match candidates. Relaxed Allows a loose match and generates the most match candidates, which increases the processing time and results in more multiple matches. Use this mode if the exact input is not known completely such as incomplete addresses and incorrect spellings. This is the only mode that does not respect the street parity when making an address match. |
Optional |
| mainAddressLine | Main address line of the address. | Required |
| addressLastLine | Last line part of the address | Optional |
| placeName | Name of the place of the address | Optional |
| areaName1 | State/Province | Optional |
| areaName2 | County/Region | Optional |
| areaName3 | City/Town | Optional |
| areaName4 | Suburb/Village | Optional |
| postCode | Zip code of the site address | Optional |
| postCodeExt | Extended Zip code part of the site address | Optional |
| country | Country part of the site address | Optional |
| addressNumber | Address number part of the site address | Optional |
| streetName | Street Name code part of the site address | Optional |
| unitType | Type of address(Apartment/house) part of the site address | Optional |
| unitValue | Apartment/House number part of the site address | Optional |