Skip to content
HallifyDevelopersSearch documentation
Open Hallify
Sections

Reservations & waitlist

Create a remote waitlist verification intent

POST/public/reservations/{publicHandle}/waitlist/intents

Creates a contact-verification intent for joining the published remote waitlist without committing an entry until verification succeeds. This bootstrap operation is intentionally public; the contact code protects conversion of the intent. A required Idempotency-Key makes retries with the same payload return the stored status and body; reusing the key with a different payload returns 409.

Authentication

x-hallify-widget-context: <HALLIFY_STOREFRONT_WIDGET_CONTEXT>

Short-lived server-authenticated widget presentation proof. It binds the configured frame origin to the exact verified parent binding and connection authority. Widget new demand requires this proof; existing native capabilities remain separate and retain their original authority and deadlines.

Connection guide

Parameters

publicHandlePath · Required

Opaque public channel handle used to resolve one venue’s published guest-facing configuration; it is not a credential.

string
Full definition
{
  "type": "string",
  "example": "example"
}
idempotency-keyHeader · Required

Required idempotency key, up to 128 characters

string
Full definition
{
  "type": "string",
  "minLength": 1,
  "maxLength": 128,
  "example": "example"
}
originHeader · Optional

Actual browser request Origin used for current presentation authorization. New demand and Storefront-bound continuations require it. Canonical Hallify browser requests use the origin configured by HALLIFY_PUBLIC_APP_URL. This header provides request context and does not authenticate a caller or replace the applicable guest credential.

string · uri
Full definition
{
  "type": "string",
  "format": "uri",
  "maxLength": 2048,
  "example": "https://example.test/resource"
}
x-hallify-connection-idHeader · Optional

Optional nonsecret connection locator for initial public channel resolution. It never grants authority or replaces an issued grant snapshot.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "minLength": 36,
  "maxLength": 36,
  "example": "9b6163a8-afea-4877-818b-8e2ae28a2845"
}

Request body

Required

Creates a contact-verification intent for joining the published remote waitlist without committing an entry until verification succeeds. This bootstrap operation is intentionally public; the contact code protects conversion of the intent.

application/json

PublicWaitlistIntentDto
Full definition
{
  "$ref": "#/components/schemas/PublicWaitlistIntentDto"
}

Responses

201Returns the original waitlist verification intent and expiry with separate nullable current delivery and retry metadata.
ReservationPublicIntentDto
Full definition
{
  "$ref": "#/components/schemas/ReservationPublicIntentDto"
}
Example response · 201 · application/json
{
  "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
  "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
  "expiresAt": "2026-12-31T18:00:00.000Z",
  "currentState": "AVAILABLE",
  "current": null
}
402Commercial coverage is required for new demand, or this operation has no original commercial admission evidence. Existing authorized reads and financial recovery remain available.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 402 · application/json
{
  "statusCode": 402,
  "error": "errors:http.failure",
  "code": "HTTP_402",
  "message": "errors:http.failure",
  "translationKey": "errors:http.failure"
}
409Idempotency key is already in progress or was reused with a different payload
IdempotencyConflictError
Full definition
{
  "$ref": "#/components/schemas/IdempotencyConflictError"
}
Example response · 409 · application/json
{
  "statusCode": 409,
  "error": "errors:http.conflict",
  "code": "IDEMPOTENCY_REQUEST_IN_PROGRESS",
  "message": "errors:idempotency.inProgress",
  "translationKey": "errors:idempotency.inProgress"
}
503Authoritative commercial state is unavailable or cannot be read within its bounded source contract. Retry the same operation after recovery.
TranslatedErrorDto
Full definition
{
  "$ref": "#/components/schemas/TranslatedErrorDto"
}
Example response · 503 · application/json
{
  "statusCode": 503,
  "error": "errors:http.serviceUnavailable",
  "code": "HTTP_SERVICE_UNAVAILABLE",
  "message": "errors:http.serviceUnavailable",
  "translationKey": "errors:http.serviceUnavailable"
}

Schemas

PublicWaitlistIntentDto

Creates a contact-verification intent for joining the published remote waitlist without committing an entry until verification succeeds.

servicePeriodIdRequired

Hallify UUID identifying service period associated with public waitlist intent.

string · uuid
Full definition
{
  "type": "string",
  "format": "uuid",
  "description": "Hallify UUID identifying service period associated with public waitlist intent.",
  "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
}
partySizeRequired

Whole-number party size recorded for public waitlist intent. Accepted values enforce minimum 1 and maximum 99.

integer
Full definition
{
  "type": "integer",
  "minimum": 1,
  "maximum": 99,
  "description": "Whole-number party size recorded for public waitlist intent. Accepted values enforce minimum 1 and maximum 99.",
  "example": 1
}
contactTypeRequired

Allowed contact type for public waitlist intent: EMAIL, PHONE.

string
Full definition
{
  "type": "string",
  "enum": [
    "EMAIL",
    "PHONE"
  ],
  "description": "Allowed contact type for public waitlist intent: EMAIL, PHONE.",
  "example": "EMAIL"
}
contactRequired

Contact for public waitlist intent. Accepted values enforce minimum length 3 and maximum length 254.

string
Full definition
{
  "type": "string",
  "minLength": 3,
  "maxLength": 254,
  "description": "Contact for public waitlist intent. Accepted values enforce minimum length 3 and maximum length 254.",
  "example": "example"
}
displayNameRequired

Human-readable display name for public waitlist intent. Accepted values enforce maximum length 120.

string
Full definition
{
  "type": "string",
  "maxLength": 120,
  "description": "Human-readable display name for public waitlist intent. Accepted values enforce maximum length 120.",
  "example": "Example name"
}
termsVersionRequired

Terms version for public waitlist intent. Accepted values enforce maximum length 64.

string
Full definition
{
  "type": "string",
  "maxLength": 64,
  "description": "Terms version for public waitlist intent. Accepted values enforce maximum length 64.",
  "example": "example"
}
privacyVersionRequired

Privacy version for public waitlist intent. Accepted values enforce maximum length 64.

string
Full definition
{
  "type": "string",
  "maxLength": 64,
  "description": "Privacy version for public waitlist intent. Accepted values enforce maximum length 64.",
  "example": "example"
}
guestRequestOptional

Guest request for public waitlist intent. Accepted values enforce maximum length 2000.

string
Full definition
{
  "type": "string",
  "maxLength": 2000,
  "description": "Guest request for public waitlist intent. Accepted values enforce maximum length 2000.",
  "example": "example"
}
Full definition
{
  "type": "object",
  "properties": {
    "servicePeriodId": {
      "type": "string",
      "format": "uuid",
      "description": "Hallify UUID identifying service period associated with public waitlist intent.",
      "example": "4846c409-f4df-40f6-81cc-1d7157a5c646"
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 99,
      "description": "Whole-number party size recorded for public waitlist intent. Accepted values enforce minimum 1 and maximum 99.",
      "example": 1
    },
    "contactType": {
      "type": "string",
      "enum": [
        "EMAIL",
        "PHONE"
      ],
      "description": "Allowed contact type for public waitlist intent: EMAIL, PHONE.",
      "example": "EMAIL"
    },
    "contact": {
      "type": "string",
      "minLength": 3,
      "maxLength": 254,
      "description": "Contact for public waitlist intent. Accepted values enforce minimum length 3 and maximum length 254.",
      "example": "example"
    },
    "displayName": {
      "type": "string",
      "maxLength": 120,
      "description": "Human-readable display name for public waitlist intent. Accepted values enforce maximum length 120.",
      "example": "Example name"
    },
    "termsVersion": {
      "type": "string",
      "maxLength": 64,
      "description": "Terms version for public waitlist intent. Accepted values enforce maximum length 64.",
      "example": "example"
    },
    "privacyVersion": {
      "type": "string",
      "maxLength": 64,
      "description": "Privacy version for public waitlist intent. Accepted values enforce maximum length 64.",
      "example": "example"
    },
    "guestRequest": {
      "type": "string",
      "maxLength": 2000,
      "description": "Guest request for public waitlist intent. Accepted values enforce maximum length 2000.",
      "example": "example"
    }
  },
  "required": [
    "servicePeriodId",
    "partySize",
    "contactType",
    "contact",
    "displayName",
    "termsVersion",
    "privacyVersion"
  ],
  "description": "Creates a contact-verification intent for joining the published remote waitlist without committing an entry until verification succeeds.",
  "example": {
    "servicePeriodId": "4846c409-f4df-40f6-81cc-1d7157a5c646",
    "partySize": 1,
    "contactType": "EMAIL",
    "contact": "example",
    "displayName": "Example name",
    "termsVersion": "example",
    "privacyVersion": "example"
  }
}
ReservationPublicIntentDto

Pending guest verification for a booking or waitlist intent.

intentIdRequired

Booking intent identifier used for verification and resend.

string · uuid
Full definition
{
  "type": "string",
  "description": "Booking intent identifier used for verification and resend.",
  "format": "uuid",
  "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
}
verificationIdRequired

Guest identity verification identifier.

string · uuid
Full definition
{
  "type": "string",
  "description": "Guest identity verification identifier.",
  "format": "uuid",
  "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
}
expiresAtRequired

Expiry time of the pending booking intent.

string · date-time
Full definition
{
  "type": "string",
  "description": "Expiry time of the pending booking intent.",
  "format": "date-time",
  "example": "2026-12-31T18:00:00.000Z"
}
currentStateRequired

Whether a separate current-state read succeeded after the original receipt committed. Unavailable enrichment never changes or replaces the original result.

string
Full definition
{
  "type": "string",
  "enum": [
    "AVAILABLE",
    "UNAVAILABLE"
  ],
  "description": "Whether a separate current-state read succeeded after the original receipt committed. Unavailable enrichment never changes or replaces the original result.",
  "example": "AVAILABLE"
}
currentRequired

Separate current redacted intent and verification state, or null when post-commit enrichment is unavailable. The top-level identifiers and expiry remain the original receipt.

object · null
Full definition
{
  "type": "object",
  "description": "Separate current redacted intent and verification state, or null when post-commit enrichment is unavailable. The top-level identifiers and expiry remain the original receipt.",
  "additionalProperties": false,
  "required": [
    "intentId",
    "kind",
    "status",
    "expiresAt",
    "expired",
    "canVerify",
    "verification",
    "serverTime"
  ],
  "properties": {
    "intentId": {
      "type": "string",
      "description": "Exact pending or historical intent identifier; its value alone grants no read or management authority.",
      "format": "uuid",
      "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
    },
    "kind": {
      "type": "string",
      "description": "Whether this intent requests a booking or a remote waitlist entry.",
      "enum": [
        "BOOKING",
        "WAITLIST"
      ],
      "example": "BOOKING"
    },
    "status": {
      "type": "string",
      "description": "Stored native intent status. Expiry is also evaluated against serverTime, without changing the persisted lifecycle during a read.",
      "enum": [
        "PENDING_VERIFICATION",
        "VERIFIED",
        "CONSUMED",
        "CANCELED",
        "EXPIRED"
      ],
      "example": "PENDING_VERIFICATION"
    },
    "expiresAt": {
      "type": "string",
      "description": "Original intent or capacity-hold expiry; reading never extends it.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "expired": {
      "type": "boolean",
      "description": "Whether the original intent expiry has passed at serverTime.",
      "example": true
    },
    "canVerify": {
      "type": "boolean",
      "description": "Whether this unconsumed intent and native contact challenge currently permit verification. Native conversion still rechecks capacity, current presentation and commercial admission.",
      "example": true
    },
    "verification": {
      "type": "object",
      "description": "Current redacted native contact-verification state. Delivery acceptance and code verification are separate; this state grants no reservation management authority.",
      "additionalProperties": false,
      "required": [
        "verificationId",
        "expiresAt",
        "status",
        "deliveryStatus",
        "attemptsRemaining",
        "canResend",
        "resendAvailableAt"
      ],
      "properties": {
        "verificationId": {
          "type": "string",
          "description": "Contact-verification identifier for this exact intent.",
          "format": "uuid",
          "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
        },
        "expiresAt": {
          "type": "string",
          "description": "Native contact-code expiry, independent of the capacity-hold or waitlist-intent expiry.",
          "format": "date-time",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "status": {
          "type": "string",
          "description": "Native challenge lifecycle: pending code, verified identity, consumed proof, or an expired or locked challenge. A consumed proof does not disclose or renew a manage capability.",
          "enum": [
            "PENDING",
            "VERIFIED",
            "CONSUMED",
            "EXPIRED",
            "LOCKED"
          ],
          "example": "PENDING"
        },
        "deliveryStatus": {
          "type": "string",
          "description": "Native verification-delivery state. Queued, sending and Core-pending work is unfinished; sent/delivered evidence does not verify the code. Failed, unknown or Core-unknown work never implies successful delivery or permission for a replacement send.",
          "enum": [
            "QUEUED",
            "SENDING",
            "CORE_PENDING",
            "CORE_UNKNOWN",
            "CORE_FAILED",
            "SENT",
            "DELIVERED",
            "FAILED",
            "RECEIVED"
          ],
          "example": "QUEUED"
        },
        "attemptsRemaining": {
          "type": "integer",
          "description": "Remaining native attempts for the pending contact code.",
          "minimum": 0,
          "example": 0
        },
        "canResend": {
          "type": "boolean",
          "description": "Whether current native verification policy and the unexpired pending intent permit requesting a resend now. Execution rechecks the policy.",
          "example": true
        },
        "resendAvailableAt": {
          "type": "string",
          "description": "Native cooldown boundary before intent expiry, or null when no further resend window is currently available. This timestamp alone does not grant resend permission.",
          "format": "date-time",
          "nullable": true,
          "example": "2026-12-31T18:00:00.000Z"
        }
      },
      "example": {
        "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
        "expiresAt": "2026-12-31T18:00:00.000Z",
        "status": "PENDING",
        "deliveryStatus": "QUEUED",
        "attemptsRemaining": 0,
        "canResend": true,
        "resendAvailableAt": null
      }
    },
    "serverTime": {
      "type": "string",
      "description": "Server instant used for the current expiry and retry projection.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    }
  },
  "nullable": true,
  "example": {
    "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
    "kind": "BOOKING",
    "status": "PENDING_VERIFICATION",
    "expiresAt": "2026-12-31T18:00:00.000Z",
    "expired": true,
    "canVerify": true,
    "verification": {
      "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
      "expiresAt": "2026-12-31T18:00:00.000Z",
      "status": "PENDING",
      "deliveryStatus": "QUEUED",
      "attemptsRemaining": 0,
      "canResend": true,
      "resendAvailableAt": null
    },
    "serverTime": "2026-12-31T18:00:00.000Z"
  }
}
Full definition
{
  "type": "object",
  "description": "Pending guest verification for a booking or waitlist intent.",
  "required": [
    "intentId",
    "verificationId",
    "expiresAt",
    "currentState",
    "current"
  ],
  "properties": {
    "intentId": {
      "type": "string",
      "description": "Booking intent identifier used for verification and resend.",
      "format": "uuid",
      "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
    },
    "verificationId": {
      "type": "string",
      "description": "Guest identity verification identifier.",
      "format": "uuid",
      "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
    },
    "expiresAt": {
      "type": "string",
      "description": "Expiry time of the pending booking intent.",
      "format": "date-time",
      "example": "2026-12-31T18:00:00.000Z"
    },
    "currentState": {
      "type": "string",
      "enum": [
        "AVAILABLE",
        "UNAVAILABLE"
      ],
      "description": "Whether a separate current-state read succeeded after the original receipt committed. Unavailable enrichment never changes or replaces the original result.",
      "example": "AVAILABLE"
    },
    "current": {
      "type": "object",
      "description": "Separate current redacted intent and verification state, or null when post-commit enrichment is unavailable. The top-level identifiers and expiry remain the original receipt.",
      "additionalProperties": false,
      "required": [
        "intentId",
        "kind",
        "status",
        "expiresAt",
        "expired",
        "canVerify",
        "verification",
        "serverTime"
      ],
      "properties": {
        "intentId": {
          "type": "string",
          "description": "Exact pending or historical intent identifier; its value alone grants no read or management authority.",
          "format": "uuid",
          "example": "fd46d9cb-163b-4669-8f68-6b8456779efd"
        },
        "kind": {
          "type": "string",
          "description": "Whether this intent requests a booking or a remote waitlist entry.",
          "enum": [
            "BOOKING",
            "WAITLIST"
          ],
          "example": "BOOKING"
        },
        "status": {
          "type": "string",
          "description": "Stored native intent status. Expiry is also evaluated against serverTime, without changing the persisted lifecycle during a read.",
          "enum": [
            "PENDING_VERIFICATION",
            "VERIFIED",
            "CONSUMED",
            "CANCELED",
            "EXPIRED"
          ],
          "example": "PENDING_VERIFICATION"
        },
        "expiresAt": {
          "type": "string",
          "description": "Original intent or capacity-hold expiry; reading never extends it.",
          "format": "date-time",
          "example": "2026-12-31T18:00:00.000Z"
        },
        "expired": {
          "type": "boolean",
          "description": "Whether the original intent expiry has passed at serverTime.",
          "example": true
        },
        "canVerify": {
          "type": "boolean",
          "description": "Whether this unconsumed intent and native contact challenge currently permit verification. Native conversion still rechecks capacity, current presentation and commercial admission.",
          "example": true
        },
        "verification": {
          "type": "object",
          "description": "Current redacted native contact-verification state. Delivery acceptance and code verification are separate; this state grants no reservation management authority.",
          "additionalProperties": false,
          "required": [
            "verificationId",
            "expiresAt",
            "status",
            "deliveryStatus",
            "attemptsRemaining",
            "canResend",
            "resendAvailableAt"
          ],
          "properties": {
            "verificationId": {
              "type": "string",
              "description": "Contact-verification identifier for this exact intent.",
              "format": "uuid",
              "example": "904a18d4-c890-4387-8e14-bc52c879c7ff"
            },
            "expiresAt": {
              "type": "string",
              "description": "Native contact-code expiry, independent of the capacity-hold or waitlist-intent expiry.",
              "format": "date-time",
              "example": "2026-12-31T18:00:00.000Z"
            },
            "status": {
              "type": "string",
              "description": "Native challenge lifecycle: pending code, verified identity, consumed proof, or an expired or locked challenge. A consumed proof does not disclose or renew a manage capability.",
              "enum": [
                "PENDING",
                "VERIFIED",
                "CONSUMED",
                "EXPIRED",
                "LOCKED"
              ],
              "example": "PENDING"
            },
            "deliveryStatus": {
              "type": "string",
              "description": "Native verification-delivery state. Queued, sending and Core-pending work is unfinished; sent/delivered evidence does not verify the code. Failed, unknown or Core-unknown work never implies successful delivery or permission for a replacement send.",
              "enum": [
                "QUEUED",
                "SENDING",
                "CORE_PENDING",
                "CORE_UNKNOWN",
                "CORE_FAILED",
                "SENT",
                "DELIVERED",
                "FAILED",
                "RECEIVED"
              ],
              "example": "QUEUED"
            },
            "attemptsRemaining": {
              "type": "integer",
              "description": "Remaining native attempts for the pending contact code.",
              "minimum": 0,
              "example": 0
            },
            "canResend": {
              "type": "boolean",
              "description": "Whether current native verification policy and the unexpired pending intent permit requesting a resend now. Execution rechecks the policy.",
              "example": true
            },
            "resendAvailableAt": {
              "type": "string",
              "description": "Native cooldown boundary before intent expiry, or null when no further resend window is currently available. This timestamp alone does not grant resend permission.",
              "format": "date-time",
              "nullable": true,
              "example": "2026-12-31T18:00:00.000Z"
            }
          },
          "example": {
            "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
            "expiresAt": "2026-12-31T18:00:00.000Z",
            "status": "PENDING",
            "deliveryStatus": "QUEUED",
            "attemptsRemaining": 0,
            "canResend": true,
            "resendAvailableAt": null
          }
        },
        "serverTime": {
          "type": "string",
          "description": "Server instant used for the current expiry and retry projection.",
          "format": "date-time",
          "example": "2026-12-31T18:00:00.000Z"
        }
      },
      "nullable": true,
      "example": {
        "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
        "kind": "BOOKING",
        "status": "PENDING_VERIFICATION",
        "expiresAt": "2026-12-31T18:00:00.000Z",
        "expired": true,
        "canVerify": true,
        "verification": {
          "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
          "expiresAt": "2026-12-31T18:00:00.000Z",
          "status": "PENDING",
          "deliveryStatus": "QUEUED",
          "attemptsRemaining": 0,
          "canResend": true,
          "resendAvailableAt": null
        },
        "serverTime": "2026-12-31T18:00:00.000Z"
      }
    }
  },
  "example": {
    "intentId": "fd46d9cb-163b-4669-8f68-6b8456779efd",
    "verificationId": "904a18d4-c890-4387-8e14-bc52c879c7ff",
    "expiresAt": "2026-12-31T18:00:00.000Z",
    "currentState": "AVAILABLE",
    "current": null
  }
}
TranslatedErrorDto

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

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

Hallify uses essential cookies and optional analytics.

Essential cookies keep sign-in, locale, and theme preferences working. Analytics is off until you choose to allow it.