Authentication
x-guest-portal-token: <HALLIFY_GUEST_PORTAL_TOKEN>Guest-owned portal session token.
Parameters
originHeader · RequiredActual browser Origin. The native owner authorizes the original source audience and current presentation. A Portal session never expands native CORS or presentation rights.
stringFull definition
{ "type": "string", "maxLength": 2048, "example": "example" }idempotency-keyHeader · RequiredRequired idempotency key, up to 128 characters
stringFull definition
{ "type": "string", "minLength": 1, "maxLength": 128, "example": "example" }targetKindPath · RequiredExact native owner kind.
stringFull definition
{ "enum": [ "RESERVATION", "WAITLIST", "PREORDER" ], "type": "string", "example": "RESERVATION" }targetIdPath · RequiredExact native target UUID.
string · uuidFull definition
{ "format": "uuid", "type": "string", "example": "9b6163a8-afea-4877-818b-8e2ae28a2845" }
Request body
Required
Verified single-use proof UUID bound to the current subject, session, target and native audience.
application/json
Full definition
{
"$ref": "#/components/schemas/IssueGuestPortalNativeEntryDto"
}Responses
200Original issuance receipt and separately evaluated current native continuation.
Full definition
{
"$ref": "#/components/schemas/GuestPortalNativeEntryResultDto"
}{
"receipt": {
"schema": "hallify.guest-portal.native-entry-receipt",
"version": 1,
"targetKind": "RESERVATION",
"targetId": "c42be69f-6a23-422e-82b8-22abbf035588",
"proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c",
"grantId": "ad6e6218-440a-4616-898d-8f092e74f534",
"issuedAt": "2026-01-15T10:00:00.000Z",
"expiresAt": "2026-12-31T18:00:00.000Z"
},
"current": {
"state": "AVAILABLE",
"manageToken": null,
"effectiveExpiresAt": null
}
}400The target, input, actual Origin, retained proof or OTP is invalid or expired.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 400,
"error": "errors:http.badRequest",
"code": "HTTP_BAD_REQUEST",
"message": "errors:http.badRequest",
"translationKey": "errors:http.badRequest"
}401The current Portal capability is invalid or its subject/session is unavailable.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 401,
"error": "errors:http.unauthorized",
"code": "HTTP_UNAUTHORIZED",
"message": "errors:http.unauthorized",
"translationKey": "errors:http.unauthorized"
}403The current native source or required contact proof is unavailable.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 403,
"error": "errors:http.forbidden",
"code": "HTTP_FORBIDDEN",
"message": "errors:http.forbidden",
"translationKey": "errors:http.forbidden"
}404No currently admitted exact native source exists in the capability-owned realm.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 404,
"error": "errors:http.notFound",
"code": "HTTP_NOT_FOUND",
"message": "errors:http.notFound",
"translationKey": "errors:http.notFound"
}409Idempotency key is already in progress or was reused with a different payload
Full definition
{
"$ref": "#/components/schemas/IdempotencyConflictError"
}{
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
}503Protected evidence, original receipt or required key policy is unavailable.
Full definition
{
"$ref": "#/components/schemas/TranslatedErrorDto"
}{
"statusCode": 503,
"error": "errors:http.serviceUnavailable",
"code": "HTTP_SERVICE_UNAVAILABLE",
"message": "errors:http.serviceUnavailable",
"translationKey": "errors:http.serviceUnavailable"
}Schemas
IssueGuestPortalNativeEntryDto
Apply a verified single-use target proof through its native management owner.
proofIdRequiredExact verified proof UUID for this subject, target and native audience; it grants no authority by itself.
string · uuidFull definition
{ "type": "string", "format": "uuid", "description": "Exact verified proof UUID for this subject, target and native audience; it grants no authority by itself.", "example": "6eeca0df-6b25-4279-8845-acecc5a1976c" }
Full definition
{
"type": "object",
"properties": {
"proofId": {
"type": "string",
"format": "uuid",
"description": "Exact verified proof UUID for this subject, target and native audience; it grants no authority by itself.",
"example": "6eeca0df-6b25-4279-8845-acecc5a1976c"
}
},
"required": [
"proofId"
],
"description": "Apply a verified single-use target proof through its native management owner.",
"example": {
"proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c"
}
}GuestPortalNativeEntryResultDto
Immutable native issuance acknowledgement and separately evaluated current continuation.
receiptRequiredOriginal durable nonsecret native acknowledgement. It grants no authority and survives later native revocation or expiry.
objectFull definition
{ "type": "object", "description": "Original durable nonsecret native acknowledgement. It grants no authority and survives later native revocation or expiry.", "required": [ "schema", "version", "targetKind", "targetId", "proofId", "grantId", "issuedAt", "expiresAt" ], "properties": { "schema": { "type": "string", "enum": [ "hallify.guest-portal.native-entry-receipt" ], "description": "Native entry acknowledgement schema.", "example": "hallify.guest-portal.native-entry-receipt" }, "version": { "type": "integer", "enum": [ 1 ], "description": "Native entry acknowledgement version.", "example": 1 }, "targetKind": { "type": "string", "enum": [ "RESERVATION", "WAITLIST", "PREORDER" ], "description": "Original native owner kind.", "example": "RESERVATION" }, "targetId": { "type": "string", "format": "uuid", "description": "Original native target.", "example": "c42be69f-6a23-422e-82b8-22abbf035588" }, "proofId": { "type": "string", "format": "uuid", "description": "Server-retained proof reference; never an authority token.", "example": "6eeca0df-6b25-4279-8845-acecc5a1976c" }, "grantId": { "type": "string", "format": "uuid", "description": "Original native grant reference; never a bearer.", "example": "ad6e6218-440a-4616-898d-8f092e74f534" }, "issuedAt": { "type": "string", "format": "date-time", "description": "Original stored proof or native command instant.", "example": "2026-01-15T10:00:00.000Z" }, "expiresAt": { "type": "string", "format": "date-time", "description": "Original stored proof or native command instant.", "example": "2026-12-31T18:00:00.000Z" } }, "example": { "schema": "hallify.guest-portal.native-entry-receipt", "version": 1, "targetKind": "RESERVATION", "targetId": "c42be69f-6a23-422e-82b8-22abbf035588", "proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c", "grantId": "ad6e6218-440a-4616-898d-8f092e74f534", "issuedAt": "2026-01-15T10:00:00.000Z", "expiresAt": "2026-12-31T18:00:00.000Z" } }currentRequiredCurrent native owner decision evaluated independently of the original receipt.
objectFull definition
{ "type": "object", "description": "Current native owner decision evaluated independently of the original receipt.", "required": [ "state", "manageToken", "effectiveExpiresAt" ], "properties": { "state": { "type": "string", "enum": [ "AVAILABLE", "SUPERSEDED", "EXPIRED", "REPROOF_REQUIRED", "UNAVAILABLE" ], "description": "Current continuation availability.", "example": "AVAILABLE" }, "manageToken": { "type": "string", "nullable": true, "description": "Freshly recovered native capability only while the current exact source, proof and actual Origin remain authorized. Kept outside Redux and caches.", "example": "synthetic-example-credential" }, "effectiveExpiresAt": { "type": "string", "format": "date-time", "description": "Current native effective deadline, independently capped by current admission, or null.", "nullable": true, "example": "2026-12-31T18:00:00.000Z" } }, "example": { "state": "AVAILABLE", "manageToken": null, "effectiveExpiresAt": null } }
Full definition
{
"type": "object",
"description": "Immutable native issuance acknowledgement and separately evaluated current continuation.",
"required": [
"receipt",
"current"
],
"properties": {
"receipt": {
"type": "object",
"description": "Original durable nonsecret native acknowledgement. It grants no authority and survives later native revocation or expiry.",
"required": [
"schema",
"version",
"targetKind",
"targetId",
"proofId",
"grantId",
"issuedAt",
"expiresAt"
],
"properties": {
"schema": {
"type": "string",
"enum": [
"hallify.guest-portal.native-entry-receipt"
],
"description": "Native entry acknowledgement schema.",
"example": "hallify.guest-portal.native-entry-receipt"
},
"version": {
"type": "integer",
"enum": [
1
],
"description": "Native entry acknowledgement version.",
"example": 1
},
"targetKind": {
"type": "string",
"enum": [
"RESERVATION",
"WAITLIST",
"PREORDER"
],
"description": "Original native owner kind.",
"example": "RESERVATION"
},
"targetId": {
"type": "string",
"format": "uuid",
"description": "Original native target.",
"example": "c42be69f-6a23-422e-82b8-22abbf035588"
},
"proofId": {
"type": "string",
"format": "uuid",
"description": "Server-retained proof reference; never an authority token.",
"example": "6eeca0df-6b25-4279-8845-acecc5a1976c"
},
"grantId": {
"type": "string",
"format": "uuid",
"description": "Original native grant reference; never a bearer.",
"example": "ad6e6218-440a-4616-898d-8f092e74f534"
},
"issuedAt": {
"type": "string",
"format": "date-time",
"description": "Original stored proof or native command instant.",
"example": "2026-01-15T10:00:00.000Z"
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Original stored proof or native command instant.",
"example": "2026-12-31T18:00:00.000Z"
}
},
"example": {
"schema": "hallify.guest-portal.native-entry-receipt",
"version": 1,
"targetKind": "RESERVATION",
"targetId": "c42be69f-6a23-422e-82b8-22abbf035588",
"proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c",
"grantId": "ad6e6218-440a-4616-898d-8f092e74f534",
"issuedAt": "2026-01-15T10:00:00.000Z",
"expiresAt": "2026-12-31T18:00:00.000Z"
}
},
"current": {
"type": "object",
"description": "Current native owner decision evaluated independently of the original receipt.",
"required": [
"state",
"manageToken",
"effectiveExpiresAt"
],
"properties": {
"state": {
"type": "string",
"enum": [
"AVAILABLE",
"SUPERSEDED",
"EXPIRED",
"REPROOF_REQUIRED",
"UNAVAILABLE"
],
"description": "Current continuation availability.",
"example": "AVAILABLE"
},
"manageToken": {
"type": "string",
"nullable": true,
"description": "Freshly recovered native capability only while the current exact source, proof and actual Origin remain authorized. Kept outside Redux and caches.",
"example": "synthetic-example-credential"
},
"effectiveExpiresAt": {
"type": "string",
"format": "date-time",
"description": "Current native effective deadline, independently capped by current admission, or null.",
"nullable": true,
"example": "2026-12-31T18:00:00.000Z"
}
},
"example": {
"state": "AVAILABLE",
"manageToken": null,
"effectiveExpiresAt": null
}
}
},
"example": {
"receipt": {
"schema": "hallify.guest-portal.native-entry-receipt",
"version": 1,
"targetKind": "RESERVATION",
"targetId": "c42be69f-6a23-422e-82b8-22abbf035588",
"proofId": "6eeca0df-6b25-4279-8845-acecc5a1976c",
"grantId": "ad6e6218-440a-4616-898d-8f092e74f534",
"issuedAt": "2026-01-15T10:00:00.000Z",
"expiresAt": "2026-12-31T18:00:00.000Z"
},
"current": {
"state": "AVAILABLE",
"manageToken": null,
"effectiveExpiresAt": null
}
}
}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"
}IdempotencyConflictError
Idempotency key is already in progress or was reused with a different payload.
Full definition
{
"example": {
"statusCode": 409,
"error": "errors:http.conflict",
"code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
"message": "errors:idempotency.inProgress",
"translationKey": "errors:idempotency.inProgress"
},
"allOf": [
{
"$ref": "#/components/schemas/TranslatedErrorDto"
},
{
"type": "object",
"required": [
"code"
],
"properties": {
"statusCode": {
"type": "integer",
"enum": [
409
],
"description": "HTTP 409 conflict status.",
"example": 409
},
"code": {
"type": "string",
"enum": [
"IDEMPOTENCY_REQUEST_NOT_READY",
"IDEMPOTENCY_KEY_PAYLOAD_MISMATCH",
"IDEMPOTENCY_REQUEST_IN_PROGRESS",
"IDEMPOTENCY_SCOPE_INCOMPLETE"
],
"description": "Allowed code for idempotency conflict error: IDEMPOTENCY_REQUEST_NOT_READY, IDEMPOTENCY_KEY_PAYLOAD_MISMATCH, IDEMPOTENCY_REQUEST_IN_PROGRESS, IDEMPOTENCY_SCOPE_INCOMPLETE.",
"example": "IDEMPOTENCY_REQUEST_NOT_READY"
}
},
"example": {
"code": "IDEMPOTENCY_REQUEST_NOT_READY"
}
}
],
"description": "Idempotency key is already in progress or was reused with a different payload."
}