Location partner ID validation rules for identifier format and external system integration
Partners Location ID
PartnersLocationIdMustBePresent
| Preconditions |
|---|
| Organization is third-party partner |
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersLocationId is present | Link |
PartnersLocationIdMustNotBeEmpty
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersLocationId is not an empty string |
PartnersLocationIdHasUnsupportedCharacter
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersLocationId does not include an unsupported character | Link |
PartnersLocationIdNotMatched
| Preconditions |
|---|
| Apple-generated ID is matched |
Organization type is AGENCY |
| Definition | Severity | API | Sample | Mode |
|---|---|---|---|---|
Validate that partnersLocationId in the last version and latest submittal match |
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": []
}
}