Authentication
x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>Guest-owned portal session token.
Parameters
No path, query or ordinary header parameters. See authentication and request body below.
Responses
200Returns the guest-visible privacy cases and statuses.
Full definition
{
"$ref": "#/components/schemas/GuestPrivacyCasePageDto"
}{
"identityRevision": 1,
"items": [
{
"id": "49292092-5109-4c46-8f6a-bd183b6e0aeb",
"requestType": "ACCESS",
"status": "OPEN",
"request": "example",
"revision": 1,
"dueAt": "2026-12-31T18:00:00.000Z",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z"
}
]
}401Rejects a missing, malformed, expired, revoked, or invalid guestPortalToken credential at the owning domain boundary.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}Schemas
GuestPrivacyCasePageDto
Returns the guest-visible privacy cases and statuses.
identityRevisionRequiredMonotonic optimistic-concurrency revision for guest portal privacy cases.
integerFull definition
{ "type": "integer", "description": "Monotonic optimistic-concurrency revision for guest portal privacy cases.", "example": 1 }itemsRequiredItems returned in the guest portal privacy cases collection.
arrayFull definition
{ "type": "array", "items": { "type": "object", "required": [ "id", "requestType", "status", "request", "revision", "dueAt", "createdAt", "updatedAt" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Hallify UUID identifying guest portal privacy cases item.", "example": "49292092-5109-4c46-8f6a-bd183b6e0aeb" }, "requestType": { "type": "string", "enum": [ "ACCESS", "PORTABILITY", "RECTIFICATION", "RESTRICTION", "ERASURE", "OBJECTION" ], "description": "Allowed request type for guest portal privacy cases item: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.", "example": "ACCESS" }, "status": { "type": "string", "enum": [ "OPEN", "VERIFIED", "APPROVED", "REJECTED", "PROCESSING", "COMPLETED", "CANCELED" ], "description": "Current lifecycle status of guest portal privacy cases item; allowed values are OPEN, VERIFIED, APPROVED, REJECTED, PROCESSING, COMPLETED, CANCELED.", "example": "OPEN" }, "request": { "type": "string", "description": "Human-entered request details submitted through guest portal privacy cases item.", "example": "example" }, "requesterVerification": { "type": "string", "nullable": true, "description": "Verification method or state recorded for the requester represented by guest portal privacy cases item. Null means no value is recorded for this representation.", "example": "example" }, "revision": { "type": "integer", "description": "Monotonic optimistic-concurrency revision for guest portal privacy cases item.", "example": 1 }, "dueAt": { "type": "string", "format": "date-time", "description": "RFC 3339 timestamp for due at; offsets represent the same absolute instant.", "example": "2026-12-31T18:00:00.000Z" }, "approvedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "RFC 3339 timestamp for approved at; offsets represent the same absolute instant. Null means no value is recorded for this representation.", "example": "2026-01-15T12:00:00.000Z" }, "completedAt": { "type": "string", "format": "date-time", "nullable": true, "description": "RFC 3339 timestamp for completed at; offsets represent the same absolute instant. Null means no value is recorded for this representation.", "example": "2026-01-15T13:00:00.000Z" }, "createdAt": { "type": "string", "format": "date-time", "description": "RFC 3339 timestamp for created at; offsets represent the same absolute instant.", "example": "2026-01-15T10:00:00.000Z" }, "updatedAt": { "type": "string", "format": "date-time", "description": "RFC 3339 timestamp for updated at; offsets represent the same absolute instant.", "example": "2026-01-15T13:00:00.000Z" } }, "example": { "id": "49292092-5109-4c46-8f6a-bd183b6e0aeb", "requestType": "ACCESS", "status": "OPEN", "request": "example", "revision": 1, "dueAt": "2026-12-31T18:00:00.000Z", "createdAt": "2026-01-15T10:00:00.000Z", "updatedAt": "2026-01-15T13:00:00.000Z" } }, "description": "Items returned in the guest portal privacy cases collection.", "example": [ { "id": "49292092-5109-4c46-8f6a-bd183b6e0aeb", "requestType": "ACCESS", "status": "OPEN", "request": "example", "revision": 1, "dueAt": "2026-12-31T18:00:00.000Z", "createdAt": "2026-01-15T10:00:00.000Z", "updatedAt": "2026-01-15T13:00:00.000Z" } ] }
Full definition
{
"type": "object",
"required": [
"identityRevision",
"items"
],
"properties": {
"identityRevision": {
"type": "integer",
"description": "Monotonic optimistic-concurrency revision for guest portal privacy cases.",
"example": 1
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"requestType",
"status",
"request",
"revision",
"dueAt",
"createdAt",
"updatedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Hallify UUID identifying guest portal privacy cases item.",
"example": "49292092-5109-4c46-8f6a-bd183b6e0aeb"
},
"requestType": {
"type": "string",
"enum": [
"ACCESS",
"PORTABILITY",
"RECTIFICATION",
"RESTRICTION",
"ERASURE",
"OBJECTION"
],
"description": "Allowed request type for guest portal privacy cases item: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
"example": "ACCESS"
},
"status": {
"type": "string",
"enum": [
"OPEN",
"VERIFIED",
"APPROVED",
"REJECTED",
"PROCESSING",
"COMPLETED",
"CANCELED"
],
"description": "Current lifecycle status of guest portal privacy cases item; allowed values are OPEN, VERIFIED, APPROVED, REJECTED, PROCESSING, COMPLETED, CANCELED.",
"example": "OPEN"
},
"request": {
"type": "string",
"description": "Human-entered request details submitted through guest portal privacy cases item.",
"example": "example"
},
"requesterVerification": {
"type": "string",
"nullable": true,
"description": "Verification method or state recorded for the requester represented by guest portal privacy cases item. Null means no value is recorded for this representation.",
"example": "example"
},
"revision": {
"type": "integer",
"description": "Monotonic optimistic-concurrency revision for guest portal privacy cases item.",
"example": 1
},
"dueAt": {
"type": "string",
"format": "date-time",
"description": "RFC 3339 timestamp for due at; offsets represent the same absolute instant.",
"example": "2026-12-31T18:00:00.000Z"
},
"approvedAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "RFC 3339 timestamp for approved at; offsets represent the same absolute instant. Null means no value is recorded for this representation.",
"example": "2026-01-15T12:00:00.000Z"
},
"completedAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "RFC 3339 timestamp for completed at; offsets represent the same absolute instant. Null means no value is recorded for this representation.",
"example": "2026-01-15T13:00:00.000Z"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "RFC 3339 timestamp for created at; offsets represent the same absolute instant.",
"example": "2026-01-15T10:00:00.000Z"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "RFC 3339 timestamp for updated at; offsets represent the same absolute instant.",
"example": "2026-01-15T13:00:00.000Z"
}
},
"example": {
"id": "49292092-5109-4c46-8f6a-bd183b6e0aeb",
"requestType": "ACCESS",
"status": "OPEN",
"request": "example",
"revision": 1,
"dueAt": "2026-12-31T18:00:00.000Z",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z"
}
},
"description": "Items returned in the guest portal privacy cases collection.",
"example": [
{
"id": "49292092-5109-4c46-8f6a-bd183b6e0aeb",
"requestType": "ACCESS",
"status": "OPEN",
"request": "example",
"revision": 1,
"dueAt": "2026-12-31T18:00:00.000Z",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z"
}
]
}
},
"description": "Returns the guest-visible privacy cases and statuses.",
"example": {
"identityRevision": 1,
"items": [
{
"id": "49292092-5109-4c46-8f6a-bd183b6e0aeb",
"requestType": "ACCESS",
"status": "OPEN",
"request": "example",
"revision": 1,
"dueAt": "2026-12-31T18:00:00.000Z",
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T13:00:00.000Z"
}
]
}
}TranslatedErrorDto
Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.
statusCodeRequiredHTTP status code repeated from the response.
integerFull definition
{ "type": "integer", "description": "HTTP status code repeated from the response.", "example": 400 }errorRequiredTranslation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.
stringFull definition
{ "type": "string", "description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.", "example": "errors.request.invalid" }codeRequiredStable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions.
stringFull definition
{ "type": "string", "example": "HTTP_BAD_REQUEST", "description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions." }messageRequiredTranslation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application." }translationKeyRequiredCanonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback.
stringFull definition
{ "type": "string", "example": "errors:http.badRequest", "description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }validationErrorsOptionalField validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.
arrayFull definition
{ "description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.", "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorDto" }, "example": [ { "field": "email", "translationKey": "validation:isEmail", "code": "isEmail", "message": "validation:isEmail" } ] }detailsOptionalOptional domain-specific blocker or validation details
oneOfFull definition
{ "description": "Optional domain-specific blocker or validation details", "oneOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/JsonValue" }, "example": [ "example" ] }, { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/JsonValue" }, "example": { "exampleKey": "example" } } ], "example": [ "example" ] }
Full definition
{
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP status code repeated from the response.",
"example": 400
},
"error": {
"type": "string",
"description": "Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.",
"example": "errors.request.invalid"
},
"code": {
"type": "string",
"example": "HTTP_BAD_REQUEST",
"description": "Stable machine-readable domain code, or an HTTP_* fallback when no domain code is provided. Branch on this field and the HTTP status; localized wording never controls retries or business decisions."
},
"message": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application."
},
"translationKey": {
"type": "string",
"example": "errors:http.badRequest",
"description": "Canonical translation key, identical to message. Status-specific errors:http.* keys cover unspecified failures. Public keys and EN/RU explanations are listed in Developers; unknown keys require a localized client fallback."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
},
"validationErrors": {
"description": "Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.",
"type": "array",
"items": {
"$ref": "#/components/schemas/ValidationErrorDto"
},
"example": [
{
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
]
},
"details": {
"description": "Optional domain-specific blocker or validation details",
"oneOf": [
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"example": [
"example"
]
}
},
"required": [
"statusCode",
"error",
"code",
"message",
"translationKey"
],
"description": "Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.",
"example": {
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}
}ValidationErrorDto
Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.
fieldRequiredPublic field path. Nested properties and array indices are separated by dots.
stringFull definition
{ "type": "string", "example": "email", "description": "Public field path. Nested properties and array indices are separated by dots." }translationKeyRequiredTranslation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog." }codeRequiredStable validator identifier for this field failure. Custom validators may define additional identifiers.
stringFull definition
{ "type": "string", "example": "isEmail", "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers." }messageRequiredTranslation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.
stringFull definition
{ "type": "string", "example": "validation:isEmail", "description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included." }translationValuesOptionalOptional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.
objectFull definition
{ "type": "object", "additionalProperties": { "oneOf": [ { "type": "string", "example": "example" }, { "type": "number", "example": 0 }, { "type": "boolean", "example": true } ], "example": "example" }, "description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.", "example": { "exampleKey": "example" } }
Full definition
{
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "email",
"description": "Public field path. Nested properties and array indices are separated by dots."
},
"translationKey": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog."
},
"code": {
"type": "string",
"example": "isEmail",
"description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
},
"message": {
"type": "string",
"example": "validation:isEmail",
"description": "Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included."
},
"translationValues": {
"type": "object",
"additionalProperties": {
"oneOf": [
{
"type": "string",
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
}
],
"example": "example"
},
"description": "Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.",
"example": {
"exampleKey": "example"
}
}
},
"required": [
"field",
"translationKey",
"code",
"message"
],
"description": "Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.",
"example": {
"field": "email",
"translationKey": "validation:isEmail",
"code": "isEmail",
"message": "validation:isEmail"
}
}JsonValue
Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.
Full definition
{
"oneOf": [
{
"type": "string",
"nullable": true,
"example": "example"
},
{
"type": "number",
"example": 0
},
{
"type": "boolean",
"example": true
},
{
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonValue"
},
"example": [
"example"
]
},
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue"
},
"example": {
"exampleKey": "example"
}
}
],
"description": "Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.",
"example": "example"
}