Skip to main content

Review content validation rules for text quality, length limits, and content restrictions

Name

NameMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that name is not dummy characters
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__NameMustNotBeDummyCharacters",
"message": "'{{field}}' value must not be dummy characters",
"severity": "VIOLATION",
"context": {
"field": "name"
},
"details": {
"createdDate": "2026-09-01T21:00:59.865Z",
"submitted": [
{
"field": "$.reviewDetails.review.name",
"value": "0"
}
],
"compared": [],
"expected": []
}
}

NameMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that name is not an empty string
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__NameMustNotBeEmpty",
"severity": "VIOLATION",
"message": "'name' must not be empty string"
}

NameIsEntirelyNumeric

DefinitionSeverityAPISampleMode
Validate that name is not entirely numeric
WARNING
POST_AND_PUT
S

NameMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that name does not include a URL
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__NameMustNotIncludeURL",
"severity": "VIOLATION",
"message": "'{{field}}' is '{{value}}' and includes URL",
"context": {
"field": "name",
"value": "Check this out! https://www.example.com"
},
"details": {
"createdDate": "2026-06-10T11:36:02.00Z",
"submitted": [
{
"field": "$.reviewDetails.review.name",
"value": "Check this out! https://www.example.com"
}
],
"compared": [],
"expected": []
}
}

NameMustNotExceedMaximum

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

NameMustNotIncludeVulgarWord

DefinitionSeverityAPISampleMode
Validate that name does not include a vulgar word
VIOLATION
POST_AND_PUT
A
Example Validation Report
{
"code": "VALIDATION__NameMustNotIncludeVulgarWord",
"severity": "VIOLATION",
"message": "'{{field}}' includes localized or universally vulgar words: '{{vulgarWords}}'",
"context": {
"field": "name",
"vulgarWords": [ "value1", "value2" ]
}
}

Review Body

ReviewBodyMustBePresent

DefinitionSeverityAPISampleMode
Validate that reviewBody is present
VIOLATION
POST_AND_PUT
Link
S

ReviewBodyMustNotBeDummyCharacters

DefinitionSeverityAPISampleMode
Validate that reviewBody is not dummy characters
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__ReviewBodyMustNotBeDummyCharacters",
"message": "'{{field}}' value must not be dummy characters",
"severity": "VIOLATION",
"context": {
"field": "reviewBody"
},
"details": {
"createdDate": "2026-09-01T21:00:59.865Z",
"submitted": [
{
"field": "$.reviewDetails.review.reviewBody",
"value": "0"
}
],
"compared": [],
"expected": []
}
}

ReviewBodyMustNotBeEmpty

DefinitionSeverityAPISampleMode
Validate that reviewBody is not an empty string
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__ReviewBodyMustNotBeEmpty",
"severity": "VIOLATION",
"message": "'reviewBody' must not be empty string"
}

ReviewBodyMustNotBeEntirelyNumeric

DefinitionSeverityAPISampleMode
Validate that the reviewBody is not entirely numeric
VIOLATION
POST_AND_PUT
S

ReviewBodyMustNotIncludeURL

DefinitionSeverityAPISampleMode
Validate that reviewBody does not include a URL
VIOLATION
POST_AND_PUT
Link
S
Example Validation Report
{
"code": "VALIDATION__ReviewBodyMustNotIncludeURL",
"severity": "VIOLATION",
"message": "'{{field}}' is '{{value}}' and includes URL",
"context": {
"field": "reviewBody",
"value": "View the full review at https://www.example.com"
},
"details": {
"createdDate": "2026-06-10T11:36:02.00Z",
"submitted": [
{
"field": "$.reviewDetails.review.reviewBody",
"value": "View the full review at https://www.example.com"
}
],
"compared": [],
"expected": []
}
}

ReviewBodyMustNotExceedMaximum

DefinitionSeverityAPISampleMode
Validate that reviewBody length does not exceed a maximum value (20,000)
VIOLATION
POST_AND_PUT
S

ReviewBodyMustNotIncludeVulgarWord

DefinitionSeverityAPISampleMode
Validate that reviewBody does not include a vulgar word
VIOLATION
POST_AND_PUT
A
Example Validation Report
{
"code": "VALIDATION__ReviewBodyMustNotIncludeVulgarWord",
"severity": "VIOLATION",
"message": "'{{field}}' includes localized or universally vulgar words: '{{vulgarWords}}'",
"context": {
"field": "reviewBody",
"vulgarWords": [ "value1", "value2" ]
}
}

ReviewBodyDuplicatesName

Preconditions
name is present
DefinitionSeverityAPISampleMode
Validate that the reviewBody is not a duplicate of name
VIOLATION
POST_AND_PUT
Link
S

Locale

LocaleMustBePresent

Preconditions
name is present
DefinitionSeverityAPISampleMode
Validate that locale is present
VIOLATION
POST_AND_PUT
S

LocaleNotSupported

Preconditions
Primary language tag is valid
Region subtag is valid
DefinitionSeverityAPISampleMode
Validate that a locale is supported
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__LocaleNotSupported",
"severity": "VIOLATION",
"message": "'{{field}}' value '{{value}}' is not supported",
"context": {
"field": "locale",
"value": "en-BE"
},
"details": {
"createdDate": "2026-09-01T21:00:59.865Z",
"submitted": [
{
"field": "$.reviewDetails.review.locale",
"value": "en-BE"
}
],
"compared": [],
"expected": []
}
}

LocaleMustNotBeEmpty

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

LangTagMustBeValidISO639Code

DefinitionSeverityAPISampleMode
Validate that the primary language tag is a valid, supported ISO 639 code
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__LangTagMustBeValidISO639Code",
"severity": "VIOLATION",
"message": "Primary language tag component of '{{value}}' in '{{field}}' is invalid or not supported",
"context": {
"field": "locale",
"value": "eng"
},
"details": {
"createdDate": "2026-09-01T21:00:59.865Z",
"submitted": [
{
"field": "$.reviewDetails.review.locale",
"value": "eng"
}
],
"compared": [],
"expected": []
}
}

RegionMustBeValidISO3166Code

DefinitionSeverityAPISampleMode
Validate that a region subtag is a valid, supported ISO 3166-1 code
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__RegionMustBeValidISO3166Code",
"severity": "VIOLATION",
"message": "Region subtag component of '{{value}}' in '{{field}}' is invalid or not supported",
"context": {
"field": "locale",
"value": "en-001"
},
"details": {
"createdDate": "2026-09-01T21:00:59.865Z",
"submitted": [
{
"field": "$.reviewDetails.review.locale",
"value": "eng-001"
}
],
"compared": [],
"expected": []
}
}

ScriptMustBeValidISO15924Code

DefinitionSeverityAPISampleMode
Validate that the script subtag is a valid, supported ISO 15924 code
VIOLATION
POST_AND_PUT
S
Example Validation Report
{
"code": "VALIDATION__ScriptMustBeValidISO15924Code",
"severity": "VIOLATION",
"message": "Script subtag component of '{{value}}' in '{{field}}' is invalid or not supported",
"context": {
"field": "locale",
"value": "ar-Arab-AE"
},
"details": {
"createdDate": "2026-09-01T21:00:59.865Z",
"submitted": [
{
"field": "$.reviewDetails.review.locale",
"value": "ar-Arab-AE"
}
],
"compared": [],
"expected": []
}
}

Unsupported Characters

ReviewNameHasUnsupportedCharacter

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

ReviewBodyHasUnsupportedCharacter

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