Skip to main content

Validation rules for brand asset image IDs including aspect ratios, resolvability, UUID format, and metadata checks

Image ID

AspectRatioMustBeWithinRangeForBrandCoverPhotoIntent

Preconditions
intent is COVER_PHOTO
DefinitionSeverityAPISampleMode
Validate that longest dimension is between >= 1.5380 and =< 1.5402 the length of the shortest dimension
VIOLATION
POST_AND_PUT
A
Example Validation Report
{
"validationReports": [
{
"code": "VALIDATION__AspectRatioMustBeWithinRangeForBrandCoverPhotoIntent",
"severity": "VIOLATION",
"message": "Aspect ratio of brand `COVER_PHOTO` must be within permitted range",
"details": {
"createdDate": "2026-09-02T11:36:02.000Z",
"submitted": [
{
"field": "$.brandAssetDetails.imageId",
"value": "1e863dc0-0980-11f0-9cd2-0242ac120002"
}
]
}
}
]
}

ImageIdMustBePresent

DefinitionSeverityAPISampleMode
Validate that imageId is present
VIOLATION
POST_AND_PUT
Link
S

ImageIdMustBeResolvable

DefinitionSeverityAPISampleMode
Validate that imageId is resolvable to an Apple-generated Image ID
VIOLATION
POST_AND_PUT
S

ImageIdMustBeAValidUUID

DefinitionSeverityAPISampleMode
Validate that imageId is a valid UUID value
VIOLATION
POST_AND_PUT
S

ImageIdMustNotBeEmpty

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

Metadata

ReferencedImageMustHaveValidFileNameExtensionForIntent

DefinitionSeverityAPISampleMode
Validate that the referenced Image's filename extension is valid for the specified Intent
VIOLATION
POST_AND_PUT
Link
S

ReferencedImageMustNotBeDeleted

DefinitionSeverityAPISampleMode
Validate that the referenced Image does not possess a DELETED resource state
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__ReferencedImageMustNotBeDeleted",
"severity": "VIOLATION",
"message": "'{{field}}' with id '{{value}}' is `DELETED`",
"context": {
"field": "imageId",
"value": "9467895078742654959"
}
}

ReferencedImageMustNotBeRejected

DefinitionSeverityAPISampleMode
Validate that the referenced Image does not possess a REJECTED resource state
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__ReferencedImageMustNotBeRejected",
"severity": "VIOLATION",
"message": "'{{field}}' with id '{{value}}' is `REJECTED`",
"context": {
"field": "imageId",
"value": "9467895078742654959"
}
}