Перейти к содержимому
HallifyРазработчикамПоиск по документации
Открыть Hallify
Разделы

Гостевой кабинет

Создать запрос по своим персональным данным

POST/guest-portal/privacy-cases

Открывает запрос доступа, переноса, исправления, возражения, ограничения обработки или удаления для своей личности.

Авторизация

x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>

Гостевой токен сессии своего кабинета.

Руководство по подключению

Параметры

Параметров пути, запроса и обычных заголовков нет. Проверьте авторизацию и тело запроса ниже.

Тело запроса

Обязательно

Тип запроса по персональным данным и его структурированное содержание для личности гостя, которой принадлежит токен.

application/json

CreateGuestPortalPrivacyCaseDto
Полное определение
{
  "$ref": "#/components/schemas/CreateGuestPortalPrivacyCaseDto"
}

Ответы

200Возвращает открытый запрос в начальном состоянии проверки.
GuestPrivacyCaseDto
Полное определение
{
  "$ref": "#/components/schemas/GuestPrivacyCaseDto"
}
Пример ответа · 200 · application/json
{
  "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"
}
401Отклоняет отсутствующий, некорректный, истёкший, отозванный или недействительный ключ guestPortalToken на границе владеющего домена.
TranslatedErrorDto
Полное определение
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Пример ответа · 401 · application/json
{
  "statusCode": 401,
  "error": "errors:http.unauthorized",
  "code": "HTTP_UNAUTHORIZED",
  "message": "errors:http.unauthorized",
  "translationKey": "errors:http.unauthorized"
}

Схемы

CreateGuestPortalPrivacyCaseDto

Тип запроса по персональным данным и его структурированное содержание для личности гостя, которой принадлежит токен.

requestTypeОбязательно

Допустимые значения requestType: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.

string
Полное определение
{
  "type": "string",
  "enum": [
    "ACCESS",
    "PORTABILITY",
    "RECTIFICATION",
    "RESTRICTION",
    "ERASURE",
    "OBJECTION"
  ],
  "description": "Допустимые значения `requestType`: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
  "example": "ACCESS"
}
requestОбязательно

Содержание запроса request, введённое человеком. Ограничения: минимальная длина 1; максимальная длина 5000.

string
Полное определение
{
  "type": "string",
  "minLength": 1,
  "maxLength": 5000,
  "description": "Содержание запроса `request`, введённое человеком. Ограничения: минимальная длина 1; максимальная длина 5000.",
  "example": "example"
}
Полное определение
{
  "type": "object",
  "properties": {
    "requestType": {
      "type": "string",
      "enum": [
        "ACCESS",
        "PORTABILITY",
        "RECTIFICATION",
        "RESTRICTION",
        "ERASURE",
        "OBJECTION"
      ],
      "description": "Допустимые значения `requestType`: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
      "example": "ACCESS"
    },
    "request": {
      "type": "string",
      "minLength": 1,
      "maxLength": 5000,
      "description": "Содержание запроса `request`, введённое человеком. Ограничения: минимальная длина 1; максимальная длина 5000.",
      "example": "example"
    }
  },
  "required": [
    "requestType",
    "request"
  ],
  "description": "Тип запроса по персональным данным и его структурированное содержание для личности гостя, которой принадлежит токен.",
  "example": {
    "requestType": "ACCESS",
    "request": "example"
  }
}
GuestPrivacyCaseDto

Возвращает запрос гостя по персональным данным с текущими состояниями проверки, решения, экспорта и завершения.

idОбязательно

UUID Hallify для id.

string · uuid
Полное определение
{
  "type": "string",
  "format": "uuid",
  "description": "UUID Hallify для `id`.",
  "example": "9b8f9433-35f3-4cdc-8620-be3bb8e1ad5b"
}
requestTypeОбязательно

Допустимые значения requestType: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.

string
Полное определение
{
  "type": "string",
  "enum": [
    "ACCESS",
    "PORTABILITY",
    "RECTIFICATION",
    "RESTRICTION",
    "ERASURE",
    "OBJECTION"
  ],
  "description": "Допустимые значения `requestType`: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
  "example": "ACCESS"
}
statusОбязательно

Текущий статус жизненного цикла status; допустимые значения: OPEN, VERIFIED, APPROVED, REJECTED, PROCESSING, COMPLETED, CANCELED.

string
Полное определение
{
  "type": "string",
  "enum": [
    "OPEN",
    "VERIFIED",
    "APPROVED",
    "REJECTED",
    "PROCESSING",
    "COMPLETED",
    "CANCELED"
  ],
  "description": "Текущий статус жизненного цикла `status`; допустимые значения: OPEN, VERIFIED, APPROVED, REJECTED, PROCESSING, COMPLETED, CANCELED.",
  "example": "OPEN"
}
requestОбязательно

Содержание запроса request, введённое человеком.

string
Полное определение
{
  "type": "string",
  "description": "Содержание запроса `request`, введённое человеком.",
  "example": "example"
}
requesterVerificationНеобязательно

Способ или состояние проверки заявителя в requesterVerification. Null означает отсутствие записанного значения в этом представлении.

string · null
Полное определение
{
  "type": "string",
  "nullable": true,
  "description": "Способ или состояние проверки заявителя в `requesterVerification`. Null означает отсутствие записанного значения в этом представлении.",
  "example": "example"
}
revisionОбязательно

Монотонно возрастающая ревизия revision для оптимистичного контроля конкурентных изменений.

integer
Полное определение
{
  "type": "integer",
  "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
  "example": 1
}
dueAtОбязательно

Время dueAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Время `dueAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
  "example": "2026-12-31T18:00:00.000Z"
}
approvedAtНеобязательно

Время approvedAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.

string · date-time · null
Полное определение
{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "description": "Время `approvedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
  "example": "2026-01-15T12:00:00.000Z"
}
completedAtНеобязательно

Время completedAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.

string · date-time · null
Полное определение
{
  "type": "string",
  "format": "date-time",
  "nullable": true,
  "description": "Время `completedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
  "example": "2026-01-15T13:00:00.000Z"
}
createdAtОбязательно

Время createdAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Время `createdAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
  "example": "2026-01-15T10:00:00.000Z"
}
updatedAtОбязательно

Время updatedAt в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.

string · date-time
Полное определение
{
  "type": "string",
  "format": "date-time",
  "description": "Время `updatedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
  "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": "UUID Hallify для `id`.",
      "example": "9b8f9433-35f3-4cdc-8620-be3bb8e1ad5b"
    },
    "requestType": {
      "type": "string",
      "enum": [
        "ACCESS",
        "PORTABILITY",
        "RECTIFICATION",
        "RESTRICTION",
        "ERASURE",
        "OBJECTION"
      ],
      "description": "Допустимые значения `requestType`: ACCESS, PORTABILITY, RECTIFICATION, RESTRICTION, ERASURE, OBJECTION.",
      "example": "ACCESS"
    },
    "status": {
      "type": "string",
      "enum": [
        "OPEN",
        "VERIFIED",
        "APPROVED",
        "REJECTED",
        "PROCESSING",
        "COMPLETED",
        "CANCELED"
      ],
      "description": "Текущий статус жизненного цикла `status`; допустимые значения: OPEN, VERIFIED, APPROVED, REJECTED, PROCESSING, COMPLETED, CANCELED.",
      "example": "OPEN"
    },
    "request": {
      "type": "string",
      "description": "Содержание запроса `request`, введённое человеком.",
      "example": "example"
    },
    "requesterVerification": {
      "type": "string",
      "nullable": true,
      "description": "Способ или состояние проверки заявителя в `requesterVerification`. Null означает отсутствие записанного значения в этом представлении.",
      "example": "example"
    },
    "revision": {
      "type": "integer",
      "description": "Монотонно возрастающая ревизия `revision` для оптимистичного контроля конкурентных изменений.",
      "example": 1
    },
    "dueAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `dueAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "approvedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Время `approvedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
      "example": "2026-01-15T12:00:00.000Z"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "Время `completedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент. Null означает отсутствие записанного значения в этом представлении.",
      "example": "2026-01-15T13:00:00.000Z"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `createdAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T10:00:00.000Z"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Время `updatedAt` в формате RFC3339; разные часовые смещения могут обозначать один абсолютный момент.",
      "example": "2026-01-15T13:00:00.000Z"
    }
  },
  "description": "Возвращает запрос гостя по персональным данным с текущими состояниями проверки, решения, экспорта и завершения.",
  "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"
  }
}
TranslatedErrorDto

Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.

statusCodeОбязательно

HTTP-статус, повторённый из ответа.

integer
Полное определение
{
  "type": "integer",
  "description": "HTTP-статус, повторённый из ответа.",
  "example": 400
}
errorОбязательно

Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.

string
Полное определение
{
  "type": "string",
  "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
  "example": "errors.request.invalid"
}
codeОбязательно

Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями.

string
Полное определение
{
  "type": "string",
  "example": "HTTP_BAD_REQUEST",
  "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
}
messageОбязательно

Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
}
translationKeyОбязательно

Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте.

string
Полное определение
{
  "type": "string",
  "example": "errors:http.badRequest",
  "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
validationErrorsНеобязательно

Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.

array
Полное определение
{
  "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ValidationErrorDto"
  },
  "example": [
    {
      "field": "email",
      "translationKey": "validation:isEmail",
      "code": "isEmail",
      "message": "validation:isEmail"
    }
  ]
}
detailsНеобязательно

Необязательные сведения о доменных препятствиях или ошибках валидации.

oneOf
Полное определение
{
  "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
  "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-статус, повторённый из ответа.",
      "example": 400
    },
    "error": {
      "type": "string",
      "description": "Ключ перевода HTTP-категории, например errors:http.conflict. Конкретную причину определяют code и translationKey.",
      "example": "errors.request.invalid"
    },
    "code": {
      "type": "string",
      "example": "HTTP_BAD_REQUEST",
      "description": "Стабильный машинный код домена либо стандартный HTTP_*, если доменный код не задан. Используйте это поле и HTTP-статус для программной логики; локализованная формулировка не управляет повторами или бизнес-решениями."
    },
    "message": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Ключ перевода, идентичный translationKey. API не возвращает локализованный текст интерфейса. Найдите перевод ключа и подставьте translationValues в приложении-потребителе."
    },
    "translationKey": {
      "type": "string",
      "example": "errors:http.badRequest",
      "description": "Канонический ключ перевода, идентичный message. Ключи errors:http.* соответствующего статуса описывают неуточнённые ошибки. Публичные ключи и пояснения EN/RU перечислены в Developers; неизвестный ключ требует локализованного запасного сообщения в клиенте."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    },
    "validationErrors": {
      "description": "Ошибки проверки полей с ключами переводов и стабильными кодами валидаторов. Введённые значения и исходные тексты валидаторов не включаются.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorDto"
      },
      "example": [
        {
          "field": "email",
          "translationKey": "validation:isEmail",
          "code": "isEmail",
          "message": "validation:isEmail"
        }
      ]
    },
    "details": {
      "description": "Необязательные сведения о доменных препятствиях или ошибках валидации.",
      "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": "Стабильная оболочка ошибки общего обработчика HTTP-исключений. Дополнительные машинные данные домена вложены в details.",
  "example": {
    "statusCode": 400,
    "error": "errors:http.badRequest",
    "code": "HTTP_BAD_REQUEST",
    "message": "errors:http.badRequest",
    "translationKey": "errors:http.badRequest"
  }
}
ValidationErrorDto

Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.

fieldОбязательно

Публичный путь поля. Вложенные свойства и индексы массива разделены точками.

string
Полное определение
{
  "type": "string",
  "example": "email",
  "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
}
translationKeyОбязательно

Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
}
codeОбязательно

Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы.

string
Полное определение
{
  "type": "string",
  "example": "isEmail",
  "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
}
messageОбязательно

Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются.

string
Полное определение
{
  "type": "string",
  "example": "validation:isEmail",
  "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
}
translationValuesНеобязательно

Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.

object
Полное определение
{
  "type": "object",
  "additionalProperties": {
    "oneOf": [
      {
        "type": "string",
        "example": "example"
      },
      {
        "type": "number",
        "example": 0
      },
      {
        "type": "boolean",
        "example": true
      }
    ],
    "example": "example"
  },
  "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
  "example": {
    "exampleKey": "example"
  }
}
Полное определение
{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "example": "email",
      "description": "Публичный путь поля. Вложенные свойства и индексы массива разделены точками."
    },
    "translationKey": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода этого валидатора, идентичный message. Найдите его в клиентском словаре; см. публичный каталог ошибок Developers."
    },
    "code": {
      "type": "string",
      "example": "isEmail",
      "description": "Стабильный идентификатор валидатора для ошибки поля. Пользовательские валидаторы могут определять дополнительные идентификаторы."
    },
    "message": {
      "type": "string",
      "example": "validation:isEmail",
      "description": "Ключ перевода, описывающий ошибку проверки поля, идентичный translationKey. Введённые значения и тексты валидаторов не включаются."
    },
    "translationValues": {
      "type": "object",
      "additionalProperties": {
        "oneOf": [
          {
            "type": "string",
            "example": "example"
          },
          {
            "type": "number",
            "example": 0
          },
          {
            "type": "boolean",
            "example": true
          }
        ],
        "example": "example"
      },
      "description": "Необязательные скалярные значения параметров шаблона перевода. Обрабатывайте их как данные, экранируйте при отображении и никогда не используйте как настройки переводчика.",
      "example": {
        "exampleKey": "example"
      }
    }
  },
  "required": [
    "field",
    "translationKey",
    "code",
    "message"
  ],
  "description": "Ошибка проверки поля с путём поля, стабильным кодом валидатора и ключом перевода. Человекочитаемый текст принадлежит приложению-потребителю.",
  "example": {
    "field": "email",
    "translationKey": "validation:isEmail",
    "code": "isEmail",
    "message": "validation:isEmail"
  }
}
JsonValue

Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.

Полное определение
{
  "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": "Рекурсивно допустимое JSON-значение. Используется только там, где контракт явно разрешает произвольные структурированные данные.",
  "example": "example"
}

Hallify использует обязательные cookies и опциональную аналитику.

Обязательные cookies поддерживают вход, язык и тему. Аналитика выключена, пока вы явно ее не разрешите.