> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.kychospitality.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ping

> A test event, sent only when you or KYC ask for one, to check that your endpoint receives and verifies webhooks. It is never sent on its own. It has no resource: `resource.id` is `null`.




## OpenAPI

````yaml openapi/kych-public-v1.0.yaml webhook webhook.ping
openapi: 3.1.0
info:
  title: KYC Hospitality Public API
  version: 1.0.0
  summary: Public REST API for hotel tech partners.
  description: >
    The KYC Hospitality public API for hotel technology partners.


    Key conventions (full detail in the design docs):

    - **Brand is the host/subdomain**; the path is brand-agnostic and identical
    across brands.

    - **Property scope** via the `Kyc-Property-Id` header — required on
    property-scoped resources, omitted on brand-wide ones (e.g. guests).

    - **Auth**: `Authorization: Bearer <key>` (prefixed `kyc_live_` /
    `kyc_test_`).

    - **Success** responses use a `{ data, meta }` envelope; every resource
    carries an `object` discriminator.

    - **Errors** are RFC 9457 `application/problem+json`, enriched with a stable
    machine `code`.

    - **Casing**: `camelCase` for all fields/params/variables; `kebab-case` for
    URL path segments.

    - **Strict** input validation; **lenient** output contract (clients must
    ignore unknown fields).
  contact:
    name: KYC API Support
    email: api-support@kychospitality.com
    url: https://docs.kychospitality.com
  license:
    name: Proprietary — © KYC Hospitality
  termsOfService: https://docs.kychospitality.com/terms
servers:
  - url: https://{service}.{brand}.kych.co/v1
    description: Production. Brand is the host; the path is brand-agnostic.
    variables:
      service:
        default: public-api
        description: API service label (not yet finalized — `public-api` or `api`).
      brand:
        default: hilton
        description: Brand subdomain, e.g. `hilton`.
security:
  - bearerAuth: []
tags:
  - name: System
    description: Utility endpoints for API information and health checks.
  - name: Properties
    description: >-
      Hotel properties within the brand. Discovery endpoints — scoped by the API
      key, not the property header.
  - name: Webhooks
    description: >-
      Events KYC sends to your endpoint (Decision 32). Endpoints are set up by
      KYC, not through the API.
paths: {}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >
        API key sent as a bearer token: `Authorization: Bearer kyc_live_...`.
        Keys are prefixed `kyc_live_` (production) or `kyc_test_` (test mode).
        OAuth2 access tokens (also `Bearer`) may be supported later — the header
        never changes.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.