Skip to main content

Location partner ID validation rules for identifier format and external system integration

Partners Location ID

PartnersLocationIdMustBePresent

Preconditions
Organization is third-party partner
DefinitionSeverityAPISampleMode
Validate that partnersLocationId is present
VIOLATION
POST_AND_PUT
Link
S

PartnersLocationIdMustNotBeEmpty

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

PartnersLocationIdHasUnsupportedCharacter

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

PartnersLocationIdNotMatched

Preconditions
Apple-generated ID is matched
Organization type is AGENCY
DefinitionSeverityAPISampleMode
Validate that partnersLocationId in the last version and latest submittal match
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__PartnersLocationIdNotMatched",
"severity": "VIOLATION",
"message": "'{{value}}' in 'partnersLocationId' does not match previous version",
"context": {
"field": "partnersLocationId",
"value": "1234567890"
},
"details": {
"createdDate": "2026-02-10T11:36:02.00Z",
"submitted": [
{
"field": "$.locationDetails.partnersLocationId",
"value": "1234567890"
}
],
"compared": [
{
"field": "$.locationDetails.partnersLocationId",
"value": "0987654321"
}
],
"expected": []
}
}