GET LocationValidation?StreetAddress1={StreetAddress1}&City={City}&ZipCode={ZipCode}&County={County}&State={State}&Country={Country}&APIIdentifier={APIIdentifier}&User={User}
The Location Validation service returns errors and warnings based on a submitted location's validity
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| StreetAddress1 | Street Address. Example: 945 East Paces Ferry (Required) |
Define this parameter in the request URI. |
| City | City name. Example: Hotlanta (Required) |
Define this parameter in the request URI. |
| ZipCode | Five digit US Zip Code. Example: 90210 (Required) |
Define this parameter in the request URI. |
| County | County name. Example: Futon (Required) |
Define this parameter in the request URI. |
| State | Two character US State code. Example: GA (Required) |
Define this parameter in the request URI. |
| Country | Two character country code, default is US. Example: US (Optional) |
Define this parameter in the request URI. |
| APIIdentifier | An identifier assigned to MGAs by RSUI. Example: 5a6c7790-83bf-4b4c-88e1-7067413d3390 (Required) |
Define this parameter in the request URI. |
| User | User Name that matches with the APIIdentifier. Example: John Smith (Required) |
Define this parameter in the request URI. |
Response Information
Empty Error and Warning messages means the address is considered valid
Response body formats
application/json, text/json
Sample:
{
"locationValidationErrors": [],
"locationValidationWarnings": [
"City for this location might be 'Atlanta'",
"Zip Code for this location might be '30326'",
"County for this location might be 'Fulton'"
]
}
text/html
Sample:
{"locationValidationErrors":[],"locationValidationWarnings":["City for this location might be 'Atlanta'","Zip Code for this location might be '30326'","County for this location might be 'Fulton'"]}
application/xml, text/xml
Sample:
<LocationValidationResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<LocationValidationErrors />
<LocationValidationWarnings>
<string>City for this location might be 'Atlanta'</string>
<string>Zip Code for this location might be '30326'</string>
<string>County for this location might be 'Fulton'</string>
</LocationValidationWarnings>
</LocationValidationResponse>
text/javascript, application/javascript, application/json-p
Sample:
({"locationValidationErrors":[],"locationValidationWarnings":["City for this location might be 'Atlanta'","Zip Code for this location might be '30326'","County for this location might be 'Fulton'"]});