Авторизация
x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>Гостевой токен сессии своего кабинета.
Параметры
associationIdПуть · ОбязательноНеизменная исходная QR association, принадлежащая аутентифицированному субъекту Portal.
string · uuidПолное определение
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }localeПараметр запроса · НеобязательноЯзык текста согласия.
stringПолное определение
{ "default": "en", "type": "string", "enum": [ "en", "ka", "ru" ], "example": "en" }
Ответы
200Последнее добавленное решение, постоянный запрет безопасности и текущий локализованный текст согласия.
Полное определение
{
"$ref": "#/components/schemas/GuestPortalQrConsentResultDto"
}{
"associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631",
"hardRevoked": true,
"currentDecision": {
"id": "f2b32ae6-a690-4986-87f0-853fb21736b7",
"associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631",
"revision": 1,
"decision": "ACCEPT",
"createdAt": "2026-01-15T10:00:00.000Z"
},
"statement": {
"purpose": "QR_HISTORY_ASSOCIATION",
"termsVersion": "example",
"termsDigest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
"locale": "en",
"text": "example"
}
}400Некорректные входные данные, изменённый текст согласия или недействительный целевой proof/OTP. Попытки с неверным OTP фиксируются.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}401Исходный QR bearer/фактический Origin или текущая сессия Portal недоступны.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}403Приватная история требует текущего подтверждения контакта. Отзыв согласия не требует свежего OTP.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 403,
"error": "errors:http.forbidden",
"code": "HTTP_FORBIDDEN",
"message": "errors:http.forbidden",
"translationKey": "errors:http.forbidden"
}404Точная принадлежащая гостю association или допустимый исходный запрос недоступны.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 404,
"error": "errors:http.notFound",
"code": "HTTP_NOT_FOUND",
"message": "errors:http.notFound",
"translationKey": "errors:http.notFound"
}429Канонический бюджет попыток проверки контакта исчерпан.
Заголовки ответа
Retry-AfterЦелое количество секунд ожидания перед повтором отклонённого запроса.
integerПолное определение
{
"type": "integer",
"minimum": 1,
"example": 60
}Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 429,
"error": "errors:http.tooManyRequests",
"code": "HTTP_TOO_MANY_REQUESTS",
"message": "errors:http.tooManyRequests",
"translationKey": "errors:http.tooManyRequests"
}503Политика защищённых данных или ключи шифрования команд недоступны.
Полное определение
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Схемы
GuestPortalQrConsentResultDto
Текущее решение о согласии, постоянный запрет безопасности и локализованный текст согласия для принадлежащей гостю association.
associationIdОбязательноИсходная association, принадлежащая текущему субъекту Portal.
string · uuidПолное определение
{ "type": "string", "format": "uuid", "description": "Исходная association, принадлежащая текущему субъекту Portal.", "example": "f73e02c0-4bf2-405f-88b4-ed9700c5f631" }hardRevokedОбязательноПостоянный запрет безопасности; повторное согласие не восстанавливает историю.
booleanПолное определение
{ "type": "boolean", "description": "Постоянный запрет безопасности; повторное согласие не восстанавливает историю.", "example": true }currentDecisionОбязательноНеизменное подтверждение исходной команды согласия, независимое от последующих решений.
objectПолное определение
{ "type": "object", "description": "Неизменное подтверждение исходной команды согласия, независимое от последующих решений.", "additionalProperties": false, "required": [ "id", "associationId", "revision", "decision", "createdAt" ], "properties": { "id": { "type": "string", "format": "uuid", "description": "Неизменный UUID квитанции команды согласия.", "example": "f2b32ae6-a690-4986-87f0-853fb21736b7" }, "associationId": { "type": "string", "format": "uuid", "description": "Исходная неизменная QR association.", "example": "f73e02c0-4bf2-405f-88b4-ed9700c5f631" }, "revision": { "type": "integer", "minimum": 1, "description": "Ревизия согласия, изменяемая только добавлением новых решений.", "example": 1 }, "decision": { "type": "string", "enum": [ "ACCEPT", "WITHDRAW" ], "description": "Решение, записанное этой командой; оно может отличаться от более позднего текущего решения.", "example": "ACCEPT" }, "createdAt": { "type": "string", "format": "date-time", "description": "Исходное время решения.", "example": "2026-01-15T10:00:00.000Z" } }, "example": { "id": "f2b32ae6-a690-4986-87f0-853fb21736b7", "associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631", "revision": 1, "decision": "ACCEPT", "createdAt": "2026-01-15T10:00:00.000Z" } }statementОбязательноТочный серверный локализованный текст явного согласия на QR-историю.
objectПолное определение
{ "type": "object", "description": "Точный серверный локализованный текст явного согласия на QR-историю.", "additionalProperties": false, "required": [ "purpose", "termsVersion", "termsDigest", "locale", "text" ], "properties": { "purpose": { "type": "string", "enum": [ "QR_HISTORY_ASSOCIATION" ], "description": "Согласие ограничено связанной исходной QR-историей.", "example": "QR_HISTORY_ASSOCIATION" }, "termsVersion": { "type": "string", "maxLength": 64, "description": "Версия серверного текста согласия.", "example": "example" }, "termsDigest": { "type": "string", "pattern": "^[a-f0-9]{64}$", "description": "Канонический digest текста согласия, связанный с целевым proof.", "example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef" }, "locale": { "type": "string", "enum": [ "en", "ka", "ru" ], "description": "Язык, показываемый гостю.", "example": "en" }, "text": { "type": "string", "description": "Точный текст согласия, который принимает гость.", "example": "example" } }, "example": { "purpose": "QR_HISTORY_ASSOCIATION", "termsVersion": "example", "termsDigest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef", "locale": "en", "text": "example" } }
Полное определение
{
"type": "object",
"description": "Текущее решение о согласии, постоянный запрет безопасности и локализованный текст согласия для принадлежащей гостю association.",
"additionalProperties": false,
"required": [
"associationId",
"hardRevoked",
"currentDecision",
"statement"
],
"properties": {
"associationId": {
"type": "string",
"format": "uuid",
"description": "Исходная association, принадлежащая текущему субъекту Portal.",
"example": "f73e02c0-4bf2-405f-88b4-ed9700c5f631"
},
"hardRevoked": {
"type": "boolean",
"description": "Постоянный запрет безопасности; повторное согласие не восстанавливает историю.",
"example": true
},
"currentDecision": {
"type": "object",
"description": "Неизменное подтверждение исходной команды согласия, независимое от последующих решений.",
"additionalProperties": false,
"required": [
"id",
"associationId",
"revision",
"decision",
"createdAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Неизменный UUID квитанции команды согласия.",
"example": "f2b32ae6-a690-4986-87f0-853fb21736b7"
},
"associationId": {
"type": "string",
"format": "uuid",
"description": "Исходная неизменная QR association.",
"example": "f73e02c0-4bf2-405f-88b4-ed9700c5f631"
},
"revision": {
"type": "integer",
"minimum": 1,
"description": "Ревизия согласия, изменяемая только добавлением новых решений.",
"example": 1
},
"decision": {
"type": "string",
"enum": [
"ACCEPT",
"WITHDRAW"
],
"description": "Решение, записанное этой командой; оно может отличаться от более позднего текущего решения.",
"example": "ACCEPT"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Исходное время решения.",
"example": "2026-01-15T10:00:00.000Z"
}
},
"example": {
"id": "f2b32ae6-a690-4986-87f0-853fb21736b7",
"associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631",
"revision": 1,
"decision": "ACCEPT",
"createdAt": "2026-01-15T10:00:00.000Z"
}
},
"statement": {
"type": "object",
"description": "Точный серверный локализованный текст явного согласия на QR-историю.",
"additionalProperties": false,
"required": [
"purpose",
"termsVersion",
"termsDigest",
"locale",
"text"
],
"properties": {
"purpose": {
"type": "string",
"enum": [
"QR_HISTORY_ASSOCIATION"
],
"description": "Согласие ограничено связанной исходной QR-историей.",
"example": "QR_HISTORY_ASSOCIATION"
},
"termsVersion": {
"type": "string",
"maxLength": 64,
"description": "Версия серверного текста согласия.",
"example": "example"
},
"termsDigest": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Канонический digest текста согласия, связанный с целевым proof.",
"example": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef"
},
"locale": {
"type": "string",
"enum": [
"en",
"ka",
"ru"
],
"description": "Язык, показываемый гостю.",
"example": "en"
},
"text": {
"type": "string",
"description": "Точный текст согласия, который принимает гость.",
"example": "example"
}
},
"example": {
"purpose": "QR_HISTORY_ASSOCIATION",
"termsVersion": "example",
"termsDigest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
"locale": "en",
"text": "example"
}
}
},
"example": {
"associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631",
"hardRevoked": true,
"currentDecision": {
"id": "f2b32ae6-a690-4986-87f0-853fb21736b7",
"associationId": "f73e02c0-4bf2-405f-88b4-ed9700c5f631",
"revision": 1,
"decision": "ACCEPT",
"createdAt": "2026-01-15T10:00:00.000Z"
},
"statement": {
"purpose": "QR_HISTORY_ASSOCIATION",
"termsVersion": "example",
"termsDigest": "deadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeefdeadbeef",
"locale": "en",
"text": "example"
}
}
}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"
}