Skip to main content

Location main address validation rules for structured address fields and geographic accuracy

Change Detection

SuspiciousRemovalOfFullAddress

DefinitionSeverityAPISampleMode
Validate that fullAddress is present when previously submitted
WARNING
PUT
S

SuspiciousRemovalOfStructuredAddress

DefinitionSeverityAPISampleMode
Validate that structuredAddress is present when previously submitted
WARNING
PUT
S

Containment

LocationContainedByUnsupportedArea

Preconditions
Organization type is location owner or unverified agency
DefinitionSeverityAPISampleMode
Validate that the geocode calculated for a structuredAddress or fullAddress is not contained by an unsupported area
WARNING
POST
A
Example Validation Report
{
"code": "VALIDATION__LocationContainedByUnsupportedArea",
"severity": "WARNING",
"message": "Support in area not available"
}

LocationSupportInAreaIsConditional

Preconditions
Organization type is location owner or unverified agency
DefinitionSeverityAPISampleMode
Validate that the geocode calculated for a structuredAddress or fullAddress is not contained by a conditionally allowed area
WARNING
POST
A
Example Validation Report
{
"code": "VALIDATION__LocationSupportInAreaIsConditional",
"severity": "WARNING",
"message": "Support in area is conditional"
}

Cross-feature

ImprobableDistanceBetweenAddressGeocodeAndDisplayPoint

Preconditions
fullAddress or structuredAddress (or both) is present and at least one is successfully geocoded
displayPoint is present
DefinitionSeverityAPISampleMode
Validate that the distance between either the fullAddress or structuredAddress geocode and the display point coordinates does not exceed a maximum distance (1000 meters)
WARNING
POST_AND_PUT
A
note

When both fullAddress and structuredAddress are present, one of the two geocodes must not exceed the maximum distance

Example Validation Report
{
"code": "VALIDATION__ImprobableDistanceBetweenAddressGeocodeAndDisplayPoint",
"severity": "WARNING",
"message": "Distance between address geocode and display point coordinates exceeds threshold",
"details": {
"createdDate": "2026-06-10T11:36:02.00Z",
"submitted": [
{
"field": "$.locationDetails.displayPoint",
"value": {
"displayPoint": {
"coordinates": {
"latitude": "29.76038",
"longitude": "95.36981"
},
"source": "CALCULATED"
}
}
},
{
"field": "$.locationDetails.mainAddress",
"value": {
"mainAddress": {
"fullAddress": "5505 W Parmer Ln, Austin, TX 78727, United States",
"locale": "en"
}
}
}
],
"compared": [],
"expected": []
}
}

Flow Chart

Following chart describes the system's behavior as it relates to this validation:

MustHaveMainAddressOrDisplayPoint

DefinitionSeverityAPISampleMode
Validate that displayPoint or mainAddress is present. (May possess both)
VIOLATION
POST_AND_PUT
S

Main Address

DistanceBetweenFullAndStructuredAddressGeocodesExceedsThreshold

Preconditions
fullAddress and structuredAddress are present and both are successfully geocoded
DefinitionSeverityAPISampleMode
Validate that the distance between fullAddress and structuredAddress geocodes does not exceed a maximum distance (500 meters)
WARNING
POST_AND_PUT
A
Example Validation Report
{
"code": "VALIDATION__DistanceBetweenFullAndStructuredAddressGeocodesExceedsThreshold",
"severity": "WARNING",
"message": "Distance between full and structured address geocodes exceeds threshold",
"details": {
"createdDate": "2026-06-10T11:36:02.00Z",
"submitted": [
{
"field": "$.locationDetails.mainAddress",
"value": {
"mainAddress": {
"fullAddress": "5505 W Parmer Ln, Austin, TX 78727, United States",
"structuredAddress": {
"fullThoroughfare": "4101 W Parmer Ln",
"thoroughfare": "W Parmer Ln",
"subThoroughfare": "4101",
"locality": "Austin",
"administrativeArea": "TX",
"countryCode": "US",
"postCode": "78727"
},
"locale": "en"
}
}
}
],
"compared": [],
"expected": []
}
}

MainAddressMustHaveFullOrStructuredAddress

Preconditions
mainAddress is present
DefinitionSeverityAPISampleMode
Validate that fullAddress or structuredAddress is present
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__MainAddressMustHaveFullOrStructuredAddress",
"severity": "VIOLATION",
"message": "Location has neither `fullAddress` nor `structuredAddress`. Provide one or other (or both). Or remove `mainAddress` and provide `displayPoint`"
}

MainAddressNotPresent

DefinitionSeverityAPISampleMode
Validate that mainAddress is present
INFO
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__MainAddressNotPresent",
"severity": "INFO",
"message": "Location has no `mainAddress`"
}

Full Address

CountryNotAllowedForOrgType

Preconditions
orgId resolves to organization that is location owner
DefinitionSeverityAPISampleMode
Validate that country derived from fullAddress is not China
VIOLATION
POST_AND_PUT
A
Example Validation Report
{
"code": "VALIDATION__CountryNotAllowedForOrgType",
"severity": "VIOLATION",
"message": "Country support for your organization type is not available"
}

CountryNotSupported

DefinitionSeverityAPISampleMode
Validate that the country derived from a fullAddress is supported
VIOLATION
POST_AND_PUT
Link
A
Example Validation Report
{
"code": "VALIDATION__CountryNotSupported",
"severity": "VIOLATION",
"message": "Country support for 'fullAddress' not available"
}

DerivedCountryCodeMustMatchBrandCountryCodes

Preconditions
brandId is present
Either structuredAddress, fullAddress, or displayPoint (or both) is present. (Deference is given to structuredAddress, then fullAddress, followed by displayPoint)
DefinitionSeverityAPISampleMode
Validate that the country derived from a structuredAddress, fullAddress, or displayPoint matches a listed country in the referenced brand
VIOLATION
POST_AND_PUT
A
Example Validation Report
{
"code": "VALIDATION__DerivedCountryCodeMustMatchBrandCountryCodes",
"severity": "VIOLATION",
"message": "Country code derived from `structuredAddress`, `fullAddress`, or `displayPoint` must match a referenced brand's country code"
}

Flow Chart

Following chart describes the system's behavior as it relates to this validation:

DisplayNamesNameIncludedInFullAddress

DefinitionSeverityAPISampleMode
Validate that fullAddress does not include any Display Names
WARNING
POST_AND_PUT
S

FullAddressIncludesPOBoxAddress

DefinitionSeverityAPISampleMode
Validate that fullAddress does not include a PO Box address component
INFO
POST_AND_PUT
S

FullAddressLengthMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that fullAddress length does not exceed a maximum value (300)
VIOLATION
POST_AND_PUT
Link
S

FullAddressMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that fullAddress is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

FullAddressMustNotBeEntirelyNumeric

DefinitionSeverityAPISampleMode
Validate that the fullAddress value is not entirely numeric
VIOLATION
POST_AND_PUT
S

FullAddressMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that fullAddress does not include a URL
VIOLATION
POST_AND_PUT
S

FullAddressMustNotIncludeVulgarWord

DefinitionSeverityAPISampleMode
Validate that fullAddress does not include a vulgar word
WARNING
POST_AND_PUT
A

FullAddressMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that fullAddress is not an empty string
VIOLATION
POST_AND_PUT
S

MainAddressFullAddressHasUnsupportedCharacter

DefinitionSeverityAPISampleMode
Validate that fullAddress does not include an unsupported character
VIOLATION
POST_AND_PUT
Link
S

Structured Address

DisplayNamesNameIncludedInStructuredAddress

DefinitionSeverityAPISampleMode
Validate that structuredAddress component does not include any Display Names
WARNING
POST_AND_PUT
S

StructuredAddressComponentHasUnsupportedCharacter

DefinitionSeverityAPISampleMode
Validate that an unsupported character is not included in any structuredAddress component
VIOLATION
POST_AND_PUT
S

StructuredAddressMustIncludeComponent

DefinitionSeverityAPISampleMode
Validate that a structuredAddress component is present when required for the country
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__StructuredAddressMustIncludeComponent",
"severity": "VIOLATION",
"message": "'{{field}}' must be present",
"context": {
"field": "fullThoroughfare"
}
}

Administrative Area

AdministrativeAreaIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that administrativeArea does not include a vulgar word
WARNING
POST_AND_PUT
A

AdministrativeAreaMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that administrativeArea length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
S

AdministrativeAreaMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that administrativeArea is not an empty string
VIOLATION
POST_AND_PUT
S

Building

BuildingMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that building is not an empty string
VIOLATION
POST_AND_PUT
S

BuildingMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that building length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
S

BuildingMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that building does not include a URL
VIOLATION
POST_AND_PUT
S

BuildingHasSuspectedUnintentionalSequentialWordRepetition

DefinitionSeverityAPISampleMode
Validate that building does not include an unintentional repetitive sequence of words
WARNING
POST_AND_PUT
S

BuildingMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that building is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

BuildingMustNotIncludeVulgarWord

DefinitionSeverityAPISampleMode
Validate that building does not include a vulgar word
VIOLATION
POST_AND_PUT
A

BuildingHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that building does not include dummy characters
WARNING
POST_AND_PUT
S

Country Code

CountryCodeMustBePresent

Preconditions
structuredAddress is present
DefinitionSeverityAPISampleMode
Validate that countryCode is present
VIOLATION
POST_AND_PUT
Link
S

CountryCodeMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that countryCode is not an empty string
VIOLATION
POST_AND_PUT
S

CountryCodeMustBeValid

DefinitionSeverityAPISampleMode
Validate that countryCode value is valid
VIOLATION
POST_AND_PUT
S

CountryCodeNotSupported

DefinitionSeverityAPISampleMode
Validate that a country code identifies a supported country
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__CountryCodeNotSupported",
"severity": "VIOLATION",
"message": "Country support for '{{field}}' value '{{value}}' not available",
"context": {
"field": "countryCode",
"value": "BY"
},
"details": {
"createdDate": "2026-09-01T21:00:59.865Z",
"submitted": [
{
"field": "$.locationDetails.mainAddress.structuredAddress.countryCode",
"value": "BY"
}
],
"compared": [],
"expected": []
}
}

CountryCodeNotAllowedForOrgType

Preconditions
orgId resolves to organization that is location owner
DefinitionSeverityAPISampleMode
Validate that countryCode is not "CN" (China)
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__CountryCodeNotAllowedForOrgType",
"severity": "VIOLATION",
"message": "Country support for your organization type is not available"
}

Dependent Locality

DependentLocalityIncludesNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that dependentLocality does not include numerical characters
WARNING
POST_AND_PUT
S

DependentLocalityIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that dependentLocality does not include a vulgar word
WARNING
POST_AND_PUT
A

DependentLocalityIsEntirelyNumerical

DefinitionSeverityAPISampleMode
Validate that dependentLocality is not entirely numerical characters
VIOLATION
POST_AND_PUT
S

DependentLocalityMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that dependentLocality is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

DependentLocalityMustNotBeEmptyArray

DefinitionSeverityAPISampleMode
Validate that structuredAddress.dependentLocality is not an empty array
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__DependentLocalityMustNotBeEmptyArray",
"message": "'{{field}}' must be omitted or contain at least one element; empty arrays are not allowed.",
"severity": "VIOLATION",
"context": {
"field": "dependentLocality"
},
"details": {
"compared": [],
"expected": [],
"submitted": [
{
"field": "$.locationDetails.structuredAddress.dependentLocality",
"value": "[]"
}
],
"createdDate": "2026-03-03T13:58:43.946Z"
}
}

DependentLocalityHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that dependentLocality does not include dummy characters
WARNING
POST_AND_PUT
S

DependentLocalityMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that dependentLocality is not an empty string
VIOLATION
POST_AND_PUT
S

DependentLocalityMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that dependentLocality length does not exceed a maximum value (50)
VIOLATION
POST_AND_PUT
S

DependentLocalityMustNotIncludeNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that dependentLocality does not include numerical characters
VIOLATION
POST_AND_PUT
S

MainAddressDependentLocalityMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that dependentLocality does not include a URL
VIOLATION
POST_AND_PUT
S

Floor

FloorMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that floor is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

FloorHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that floor does not include dummy characters
WARNING
POST_AND_PUT
S

FloorMustNotIncludeVulgarWord

DefinitionSeverityAPISampleMode
Validate that floor does not include a vulgar word
VIOLATION
POST_AND_PUT
A

FloorMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that floor is not an empty string
VIOLATION
POST_AND_PUT
S

FloorMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that floor length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
S

FloorMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that floor does not include a URL
VIOLATION
POST_AND_PUT
S

FloorHasSuspectedUnintentionalSequentialWordRepetition

DefinitionSeverityAPISampleMode
Validate that floor does not include an unintentional repetitive sequence of words
WARNING
POST_AND_PUT
S

Full Thoroughfare

FullThoroughfareIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare does not include a vulgar word
WARNING
POST_AND_PUT
A

FullThoroughfareMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

FullThoroughfareHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare does not include dummy characters
WARNING
POST_AND_PUT
S

FullThoroughfareMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare is not an empty string
VIOLATION
POST_AND_PUT
S

FullThoroughfareMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
S

FullThoroughfareMustExceedMinimum

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare length exceeds a minimum value (2)
VIOLATION
POST_AND_PUT
S

FullThoroughfareMustNotBeEntirelyNumeric

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare does not include numerical characters
VIOLATION
POST_AND_PUT
S

FullThoroughfareMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that fullThoroughfare does not include a URL
VIOLATION
POST_AND_PUT
S

Geocoding

AddressMustBeGeocoded

Preconditions
displayPoint is not present
DefinitionSeverityAPISampleMode
Validate that mainAddress (fullAddress or structuredAddress) can be geocoded
VIOLATION
POST_AND_PUT
A

FullAndStructuredAddressGeocodesNotEqual

DefinitionSeverityAPISampleMode
Validate that fullAddress and structuredAddress geocodes (calculated coordinates) are equal
WARNING
POST_AND_PUT
A

FullAndStructuredAddressGeocodesNotInProximity

DefinitionSeverityAPISampleMode
Validate that fullAddress and structuredAddress geocodes (calculated coordinates) are within proximity of one another (1 meter distance)
WARNING
POST_AND_PUT
A

FullAddressGeocodingUnsuccessful

DefinitionSeverityAPISampleMode
Validate that fullAddress can be geocoded
INFO
POST_AND_PUT
A

StructuredAddressGeocodingUnsuccessful

DefinitionSeverityAPISampleMode
Validate that structuredAddress can be geocoded
INFO
POST_AND_PUT
A

Locality

LocalityIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that locality does not include a vulgar word
WARNING
POST_AND_PUT
A

LocalityIsEntirelyNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that locality is not entirely numerical characters
VIOLATION
POST_AND_PUT
S

LocalityMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that locality is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

LocalityHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that locality does not include dummy characters
WARNING
POST_AND_PUT
S

LocalityMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that locality is not an empty string
VIOLATION
POST_AND_PUT
S

LocalityMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that locality length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
Link
S

LocalityMustNotIncludeNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that locality does not include numerical characters
VIOLATION
POST_AND_PUT
S

LocalityMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that locality does not include a URL
VIOLATION
POST_AND_PUT
S

Post Code

PostCodeIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that postCode does not include a vulgar word
WARNING
POST_AND_PUT
A

PostcodeMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that postCode is not an empty string
VIOLATION
POST_AND_PUT
S

PostCodeFormatMustBeValidForCountryCode

Preconditions
structuredAddress is present
DefinitionSeverityAPISampleMode
Validate that postCode format is valid for corresponding country identified by countryCode in structuredAddress
VIOLATION
POST_AND_PUT
S

PostCodeMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that postCode is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

PostCodeMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that postCode length does not exceed a maximum value (10)
VIOLATION
POST_AND_PUT
S

Sub-Administrative Area

SubAdministrativeAreaIncludesNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea does not include numerical characters
WARNING
POST_AND_PUT
S

SubAdministrativeAreaIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea does not include a vulgar word
WARNING
POST_AND_PUT
A

SubAdministrativeAreaIsEntirelyNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea is not entirely numerical characters
VIOLATION
POST_AND_PUT
S

SubAdministrativeAreaMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea is not an empty string
VIOLATION
POST_AND_PUT
S

SubAdministrativeAreaMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea does not include a URL
VIOLATION
POST_AND_PUT
S

SubAdministrativeAreaMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
Link
S

SubAdministrativeAreaMustNotIncludeNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea does not include numerical characters
VIOLATION
POST_AND_PUT
S

SubAdministrativeAreaMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

SubAdministrativeAreaHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that subAdministrativeArea does not include dummy characters
WARNING
POST_AND_PUT
S

Sub-Locality

SubLocalityIncludesNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that sublocality does not include numerical characters
WARNING
POST_AND_PUT
S

SubLocalityIsEntirelyNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that sublocality is not entirely numerical characters
VIOLATION
POST_AND_PUT
S

SubLocalityMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that subLocality is not an empty string
VIOLATION
POST_AND_PUT
S

SubLocalityMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that subLocality does not include a URL
VIOLATION
POST_AND_PUT
S

SubLocalityMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that subLocality length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
S

SubLocalityMustNotIncludeNumericalCharacters

DefinitionSeverityAPISampleMode
Validate that subLocality does not include numerical characters
VIOLATION
POST_AND_PUT
S

SubLocalityMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that subLocality is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

SubLocalityHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that subLocality does not include dummy characters
WARNING
POST_AND_PUT
S

Sub-thoroughfare

SubThoroughfareIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that subThoroughfare does not include a vulgar word
WARNING
POST_AND_PUT
A

SubThoroughfareMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that subThoroughfare is not an empty string
VIOLATION
POST_AND_PUT
S

SubThoroughfareMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that subThoroughfare length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
Link
S

SubThoroughfareMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that subThoroughfare is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

SubThoroughfareHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that subThoroughfare does not include dummy characters
WARNING
POST_AND_PUT
S

SubThoroughfarePresentWithoutThoroughfare

DefinitionSeverityAPISampleMode
Validate that subThoroughfare is not present when thoroughfare is also not present
WARNING
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__SubThoroughfarePresentWithoutThoroughfare",
"severity": "WARNING",
"message": "'{{field}}' has value '{{value}}'. `thoroughfare` typically accompanies '{{field}}'",
"context": {
"field": "subThoroughfare",
"value": "23"
}
}

Thoroughfare

ThoroughfareIncludesVulgarWord

DefinitionSeverityAPISampleMode
Validate that thoroughfare does not include a vulgar word
WARNING
POST_AND_PUT
A

StructuredAddressMustIncludeFullThoroughfareOrThoroughfare

Preconditions
structuredAddress is present
DefinitionSeverityAPISampleMode
Validate that fullThoroughfare or thoroughfare is present when conditionally required
VIOLATION
POST_AND_PUT
Link
S

ThoroughfareMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that thoroughfare is not an empty string
VIOLATION
POST_AND_PUT
S

ThoroughfareMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that thoroughfare length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
Link
S

ThoroughfareMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that thoroughfare is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

ThoroughfareHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that thoroughfare does not include dummy characters
WARNING
POST_AND_PUT
S

Unit

UnitMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that unit is not exclusively dummy characters
VIOLATION
POST_AND_PUT
Link
S

UnitMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that unit does not include a URL
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__UnitMustNotIncludeURL",
"severity": "VIOLATION",
"message": "'{{field}}' is '{{value}}' and includes URL",
"context": {
"field": "unit",
"value": "http://www.example.com/"
},
"details": {
"createdDate": "2026-08-10T11:36:02.00Z",
"submitted": [
{
"field": "$.locationDetails.mainAddress.structuredAddress.unit",
"value": "http://www.example.com/"
}
],
"compared": [],
"expected": []
}
}

UnitMustNotIncludeVulgarWord

DefinitionSeverityAPISampleMode
Validate that unit does not include a vulgar word
VIOLATION
POST_AND_PUT
A

UnitHasSuspectedPresenceOfDummyCharacters

DefinitionSeverityAPISampleMode
Validate that unit does not include dummy characters
WARNING
POST_AND_PUT
S

UnitMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that unit is not an empty string
VIOLATION
POST_AND_PUT
S

UnitMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that unit length does not exceed a maximum value (255)
VIOLATION
POST_AND_PUT
Link
S

UnitHasSuspectedUnintentionalSequentialWordRepetition

DefinitionSeverityAPISampleMode
Validate that unit does not include an unintentional repetitive sequence of words
WARNING
POST_AND_PUT
S

Locale

MainAddressRequiresAtLeastOneSupportedLocale

DefinitionSeverityAPISampleMode
Validate that at least one (1) supported locale is present
VIOLATION
POST_AND_PUT
S

MainAddressLocaleMustBePresent

Preconditions
mainAddress is present
DefinitionSeverityAPISampleMode
Validate that locale is present
VIOLATION
POST_AND_PUT
Link
S

MainAddressLocaleMustBeValid

DefinitionSeverityAPISampleMode
Validate that locale is valid
VIOLATION
POST_AND_PUT
Link
S

MainAddressLocaleMustNotBeEmpty

Preconditions
mainAddress is present
DefinitionSeverityAPISampleMode
Validate that locale is not an empty string
VIOLATION
POST_AND_PUT
S