Create a guest-owned privacy request

Privacy-request type and the structured request details submitted for the capability-owned guest identity.

requestTypeRequired

Allowed request type for guest portal privacy case: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.

string

Full definition

{
  "type": "string",
  "enum": [
    "ACCESS",
    "PORTABILITY",
    "RECTIFICATION",
    "RESTRICTION",
    "ERASURE",
    "OBJECTION"
  ],
  "description": "Allowed request type for guest portal privacy case: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
  "example": "ACCESS"
}

requestRequired

Human-entered request details submitted through guest portal privacy case. Accepted values enforce minimum length 1 and maximum length 5000.

string

Full definition

{
  "type": "string",
  "minLength": 1,
  "maxLength": 5000,
  "description": "Human-entered request details submitted through guest portal privacy case. Accepted values enforce minimum length 1 and maximum length 5000.",
  "example": "example"
}

{
  "type": "object",
  "properties": {
    "requestType": {
      "type": "string",
      "enum": [
        "ACCESS",
        "PORTABILITY",
        "RECTIFICATION",
        "RESTRICTION",
        "ERASURE",
        "OBJECTION"
      ],
      "description": "Allowed request type for guest portal privacy case: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
      "example": "ACCESS"
    },
    "request": {
      "type": "string",
      "minLength": 1,
      "maxLength": 5000,
      "description": "Human-entered request details submitted through guest portal privacy case. Accepted values enforce minimum length 1 and maximum length 5000.",
      "example": "example"
    }
  },
  "required": [
    "requestType",
    "request"
  ],
  "description": "Privacy-request type and the structured request details submitted for the capability-owned guest identity.",
  "example": {
    "requestType": "ACCESS",
    "request": "example"
  }
}

Returns the guest privacy case with its current verification, decision, export, and completion state.

idRequired

Hallify UUID identifying guest portal privacy case.

string · uuid

Full definition

{
  "type": "string",
  "format": "uuid",
  "description": "Hallify UUID identifying guest portal privacy case.",
  "example": "9b8f9433-35f3-4cdc-8620-be3bb8e1ad5b"
}

requestTypeRequired

Allowed request type for guest portal privacy case: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.

string

Full definition

{
  "type": "string",
  "enum": [
    "ACCESS",
    "PORTABILITY",
    "RECTIFICATION",
    "RESTRICTION",
    "ERASURE",
    "OBJECTION"
  ],
  "description": "Allowed request type for guest portal privacy case: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
  "example": "ACCESS"
}

statusRequired

Current lifecycle status of guest portal privacy case; allowed values are OPEN, VERIFIED, APPROVED, REJECTED, PROCESSING, COMPLETED, CANCELED.

string

Full definition

{
  "type": "string",
  "enum": [
    "OPEN",
    "VERIFIED",
    "APPROVED",
    "REJECTED",
    "PROCESSING",
    "COMPLETED",
    "CANCELED"
  ],
  "description": "Current lifecycle status of guest portal privacy case; allowed values are OPEN, VERIFIED, APPROVED, REJECTED, PROCESSING, COMPLETED, CANCELED.",
  "example": "OPEN"
}

requestRequired

Human-entered request details submitted through guest portal privacy case.

string

Full definition

{
  "type": "string",
  "description": "Human-entered request details submitted through guest portal privacy case.",
  "example": "example"
}

requesterVerificationOptional

Verification method or state recorded for the requester represented by guest portal privacy case. Null means no value is recorded for this representation.

string · null

Full definition

{
  "type": "string",
  "nullable": true,
  "description": "Verification method or state recorded for the requester represented by guest portal privacy case. Null means no value is recorded for this representation.",
  "example": "example"
}

revisionRequired

Monotonic optimistic-concurrency revision for guest portal privacy case.

integer

Full definition

{
  "type": "integer",
  "description": "Monotonic optimistic-concurrency revision for guest portal privacy case.",
  "example": 1
}

dueAtRequired

RFC 3339 timestamp for due at; offsets represent the same absolute instant.

string · date-time

Full definition

{
  "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"
}

approvedAtOptional

RFC 3339 timestamp for approved at; offsets represent the same absolute instant. Null means no value is recorded for this representation.

string · date-time · null

Full definition

{
  "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"
}

completedAtOptional

RFC 3339 timestamp for completed at; offsets represent the same absolute instant. Null means no value is recorded for this representation.

string · date-time · null

Full definition

{
  "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"
}

createdAtRequired

RFC 3339 timestamp for created at; offsets represent the same absolute instant.

string · date-time

Full definition

{
  "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"
}

updatedAtRequired

RFC 3339 timestamp for updated at; offsets represent the same absolute instant.

string · date-time

Full definition

{
  "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"
}

{
  "type": "object",
  "required": [
    "id",
    "requestType",
    "status",
    "request",
    "revision",
    "dueAt",
    "createdAt",
    "updatedAt"
  ],
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Hallify UUID identifying guest portal privacy case.",
      "example": "9b8f9433-35f3-4cdc-8620-be3bb8e1ad5b"
    },
    "requestType": {
      "type": "string",
      "enum": [
        "ACCESS",
        "PORTABILITY",
        "RECTIFICATION",
        "RESTRICTION",
        "ERASURE",
        "OBJECTION"
      ],
      "description": "Allowed request type for guest portal privacy case: 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 case; 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 case.",
      "example": "example"
    },
    "requesterVerification": {
      "type": "string",
      "nullable": true,
      "description": "Verification method or state recorded for the requester represented by guest portal privacy case. Null means no value is recorded for this representation.",
      "example": "example"
    },
    "revision": {
      "type": "integer",
      "description": "Monotonic optimistic-concurrency revision for guest portal privacy case.",
      "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"
    }
  },
  "description": "Returns the guest privacy case with its current verification, decision, export, and completion state.",
  "example": {
    "id": "9b8f9433-35f3-4cdc-8620-be3bb8e1ad5b",
    "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"
  }
}

Stable error envelope emitted by the global HTTP exception boundary. Domain-specific machine data, when present, is nested under details.

statusCodeRequired

HTTP status code repeated from the response.

integer

Full definition

{
  "type": "integer",
  "description": "HTTP status code repeated from the response.",
  "example": 400
}

errorRequired

Translation key for the HTTP category, such as errors:http.conflict. The specific cause is identified by code and translationKey.

string

Full 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"
}

codeRequired

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.

string

Full 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."
}

messageRequired

Translation key, identical to translationKey. The API does not return localized display text. Resolve the key and translationValues in the consuming application.

string

Full 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."
}

translationKeyRequired

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.

string

Full 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."
}

translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object

Full 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"
  }
}

validationErrorsOptional

Field validation failures with translation keys and stable validator codes. Submitted values and raw validator text are not included.

array

Full 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"
    }
  ]
}

detailsOptional

Optional domain-specific blocker or validation details

oneOf

Full 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"
  ]
}

{
  "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"
  }
}

Field validation failure with a field path, stable validator code and a translation key. Human-readable text belongs to the consuming application.

fieldRequired

Public field path. Nested properties and array indices are separated by dots.

string

Full definition

{
  "type": "string",
  "example": "email",
  "description": "Public field path. Nested properties and array indices are separated by dots."
}

translationKeyRequired

Translation key for this validator, identical to message. Resolve it using a client dictionary; see the public Developers error catalog.

string

Full 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."
}

codeRequired

Stable validator identifier for this field failure. Custom validators may define additional identifiers.

string

Full definition

{
  "type": "string",
  "example": "isEmail",
  "description": "Stable validator identifier for this field failure. Custom validators may define additional identifiers."
}

messageRequired

Translation key describing this field validation failure, identical to translationKey. Submitted values and validator prose are not included.

string

Full 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."
}

translationValuesOptional

Optional scalar values for placeholders in the translation. Treat values as data, escape them when rendering, and never use them as translation options.

object

Full 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"
  }
}

{
  "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"
  }
}

Recursively JSON-safe value used only where the owning contract intentionally allows free-form structured data.

{
  "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"
}