{
"type": "https://docs.kychospitality.com/errors/internal-error",
"title": "Internal server error",
"status": 500,
"detail": "An unexpected error occurred. Contact support with the requestId.",
"moreInfo": "",
"instance": "/v1/guests",
"code": "INTERNAL_ERROR",
"errors": [],
"requestId": "req_01J9Z3K8Q2X7C5N0",
"timestamp": "2026-06-25T22:01:01.010Z"
}
{
"type": "https://docs.kychospitality.com/errors/service-unavailable",
"title": "Service unavailable",
"status": 503,
"detail": "The service is temporarily unavailable. Retry after 30 seconds.",
"moreInfo": "",
"instance": "/v1/properties",
"code": "SERVICE_UNAVAILABLE",
"errors": [],
"requestId": "req_01J9Z3K8Q2X7C5N0",
"timestamp": "2026-06-25T22:01:01.010Z"
}
System
Get API info
Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick “am I hitting the right endpoint with a valid key” check.
{
"type": "https://docs.kychospitality.com/errors/internal-error",
"title": "Internal server error",
"status": 500,
"detail": "An unexpected error occurred. Contact support with the requestId.",
"moreInfo": "",
"instance": "/v1/guests",
"code": "INTERNAL_ERROR",
"errors": [],
"requestId": "req_01J9Z3K8Q2X7C5N0",
"timestamp": "2026-06-25T22:01:01.010Z"
}
{
"type": "https://docs.kychospitality.com/errors/service-unavailable",
"title": "Service unavailable",
"status": 503,
"detail": "The service is temporarily unavailable. Retry after 30 seconds.",
"moreInfo": "",
"instance": "/v1/properties",
"code": "SERVICE_UNAVAILABLE",
"errors": [],
"requestId": "req_01J9Z3K8Q2X7C5N0",
"timestamp": "2026-06-25T22:01:01.010Z"
}
Authorizations
Authorization
string
header
required
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.
Headers
User-Agent
string
required
Identifies the calling application. 3–255 printable ASCII characters.
Required string length: 3 - 255
Pattern: ^[\x20-\x7E]+$
Kyc-Correlation-Id
string
Optional caller-supplied opaque ID for log correlation. Echoed back and logged. Treated opaquely (never decoded). Must match the pattern below.
Pattern: ^[A-Za-z0-9._=+/-]{1,128}$
traceparent
string
Optional W3C Trace Context header for distributed tracing. A malformed value is ignored and a fresh trace is started (per the W3C spec) — it never causes a 4xx.
Response
API information.
data
object
required
Response body for the API info endpoint.
Hide child attributes
data.object
string
required
Resource type discriminator.
Allowed value: "api_info"
data.apiVersion
string
required
The live API version, matching the URL version segment.
Example:
"v1"
data.documentationUrl
string<uri>
required
Base URL of the public documentation site.
Example:
"https://docs.kychospitality.com"
meta
object
required
Metadata present on every success response.
Hide child attributes
meta.requestId
string
required
Server-generated ID for this request (mirrors the Kyc-Request-Id header).
Example:
"req_01J9Z3K8Q2X7C5N0"
meta.timestamp
string<date-time>
required
UTC timestamp, ISO 8601 with milliseconds.
Example:
"2026-06-25T22:01:01.010Z"
meta.pagination
object
Present only on list responses.
Hide child attributes
meta.pagination.page
integer
required
Current page number (1-based).
Required range: x >= 1
meta.pagination.perPage
integer
required
Items per page.
Required range: x >= 1
meta.pagination.total
integer
required
Total items across all pages.
Required range: x >= 0
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"KYCH Public API","colors":{"primary":"#007799","light":"#91e3ff","dark":"#005e7f"},"logo":{"light":"https://mintcdn.com/kych-api/12fbZITjhjaHP-wP/logo/KYC_Logo2019_LG.png?fit=max\u0026auto=format\u0026n=12fbZITjhjaHP-wP\u0026q=85\u0026s=cefb1a32385dbab34dc6e5b2ea0d4818","dark":"https://mintcdn.com/kych-api/PsI7KkhyZoJkzvCm/logo/dark.svg?fit=max\u0026auto=format\u0026n=PsI7KkhyZoJkzvCm\u0026q=85\u0026s=e304f042b070b38e4afec71272133af3"},"favicon":"https://mintcdn.com/kych-api/7i7tXOdK23ubC-dK/favicon.svg?fit=max\u0026auto=format\u0026n=7i7tXOdK23ubC-dK\u0026q=85\u0026s=5f605ec12d2a5c2ef75f9f1bec697f88","api":{"openapi":["openapi/kych-public-v1.0.yaml"],"params":{"expanded":"all","post":["nullable","x-internal"]},"playground":{"display":"interactive"},"examples":{"defaults":"all","languages":["curl","javascript","php","java"],"prefill":true,"autogenerate":true},"url":"full"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:support@Kychospitality.com","label":"Support"}],"primary":{"type":"button","label":"KYC","href":"https://www.kychospitality.com/"}},"footer":{"socials":{"website":"https://www.kychospitality.com/"}},"icons":{"library":"fontawesome"},"banner":{"content":"⚠️ Alpha: API is not yet available","dismissible":false,"type":"warning"},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kych-api","hasAudioNarration":false,"actualSubdomain":"kych-api","customDomains":["api-docs.kychospitality.com"],"gitSource":{"type":"gitlab","owner":"kych-software/projects","repo":"kych-public-api","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"projectId":85246669,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aef654cf82d95316f4e6b5d","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Guides","count":18},{"language":"default","tag":"Webhooks","count":7},{"language":"default","tag":"API Reference","count":6},{"language":"default","tag":"Using the API","count":4},{"language":"default","tag":"Core Concepts","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Properties","count":2},{"language":"default","tag":"System","count":2},{"language":"default","tag":"Authentication \u0026 Security","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/system/get-api-info","slug":"/api-reference/system/get-api-info","pageMetadata":{"openapi":"get /","title":"Get API info","description":"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \"am I hitting the right endpoint with a valid key\" check.\n","href":"/api-reference/system/get-api-info"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick “am I hitting the right endpoint with a valid key” check.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /","title":"Get API info","description":"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \"am I hitting the right endpoint with a valid key\" check.\n","href":"/api-reference/system/get-api-info"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getApiInfo","tags":["System"],"summary":"Get API info","description":"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \"am I hitting the right endpoint with a valid key\" check.\n","parameters":["f160ba21-05e1-430b-9d0d-8518f2aeb79f","72025ace-42b2-489c-826b-c4284c4806cb","c4df630c-3f54-4562-ac3c-c101becfc9fa"],"responses":{"200":"a354c9d9-e8ef-43c8-8dac-689997b7adba","401":"c4107427-a052-48b8-8669-032e12a042ef","403":"946f034c-749e-4b1a-b7c9-8a04209c255e","406":"74542db7-1a12-413c-8399-764745f70f19","429":"e0723450-6679-48c5-9c75-e117898c647a","500":"010839fa-6069-416d-a381-dcf755835753","503":"fe4e9daa-f1e7-4205-83d8-fad7b5ac8d87"},"method":"get","type":"path","servers":["48f744ac-5663-4212-86f1-93e67270d604"],"security":["68c49776-3b3f-4686-971b-01241367e443"],"path":"/","baseUrlOptions":["https://{service}.{brand}.kych.co/v1"],"title":"Get API info","codeSamples":[],"requestExampleLanguages":["bash","javascript","php","java"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[],"urlDisplay":"full"},"dependencies":{"parameters":{"f160ba21-05e1-430b-9d0d-8518f2aeb79f":{"name":"User-Agent","in":"header","required":true,"description":"Identifies the calling application. 3–255 printable ASCII characters.","schema":{"type":"string","minLength":3,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$","isRequired":true,"description":"Identifies the calling application. 3–255 printable ASCII characters.","uniqueKey":"","typeLabel":"string"},"example":"AcmePMS/2.3 (+https://acme.example.com)"},"72025ace-42b2-489c-826b-c4284c4806cb":{"name":"Kyc-Correlation-Id","in":"header","required":false,"description":"Optional caller-supplied opaque ID for log correlation. Echoed back and logged. Treated opaquely (never decoded). Must match the pattern below.\n","schema":{"type":"string","pattern":"^[A-Za-z0-9._=+/-]{1,128}$","isRequired":false,"description":"Optional caller-supplied opaque ID for log correlation. Echoed back and logged. Treated opaquely (never decoded). Must match the pattern below.\n","uniqueKey":"","typeLabel":"string"},"example":"6f1c2a9e-4d3b-4c8a-9e2f-7b1a0d5c3e21"},"c4df630c-3f54-4562-ac3c-c101becfc9fa":{"name":"traceparent","in":"header","required":false,"description":"Optional W3C Trace Context header for distributed tracing. A malformed value is ignored and a fresh trace is started (per the W3C spec) — it never causes a 4xx.\n","schema":{"type":"string","isRequired":false,"description":"Optional W3C Trace Context header for distributed tracing. A malformed value is ignored and a fresh trace is started (per the W3C spec) — it never causes a 4xx.\n","uniqueKey":"","typeLabel":"string"},"example":"00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01"}},"responses":{"a354c9d9-e8ef-43c8-8dac-689997b7adba":{"description":"API information.","headers":{"Kyc-Request-Id":{"description":"Server-generated request ID. Present on every response. Mirrors `meta.requestId`.","schema":{"type":"string"},"example":"req_01J9Z3K8Q2X7C5N0"},"Kyc-Correlation-Id":{"description":"Echo of the caller's `Kyc-Correlation-Id`, present only when one was sent.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","required":["data","meta"],"properties":{"data":{"type":"object","description":"Response body for the API info endpoint.","required":["object","apiVersion","documentationUrl"],"properties":{"object":{"type":"string","const":"api_info","description":"Resource type discriminator.","isRequired":true,"uniqueKey":"data.object","typeLabel":"string"},"apiVersion":{"type":"string","description":"The live API version, matching the URL version segment.","examples":["v1"],"isRequired":true,"uniqueKey":"data.apiVersion","typeLabel":"string"},"documentationUrl":{"type":"string","format":"uri","description":"Base URL of the public documentation site.","examples":["https://docs.kychospitality.com"],"isRequired":true,"uniqueKey":"data.documentationUrl","typeLabel":"string\u003curi>"}},"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","description":"Metadata present on every success response.","required":["requestId","timestamp"],"properties":{"requestId":{"type":"string","description":"Server-generated ID for this request (mirrors the `Kyc-Request-Id` header).","examples":["req_01J9Z3K8Q2X7C5N0"],"isRequired":true,"uniqueKey":"meta.requestId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"UTC timestamp, ISO 8601 with milliseconds.","examples":["2026-06-25T22:01:01.010Z"],"isRequired":true,"uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"},"pagination":{"type":"object","description":"Present only on list responses.","required":["page","perPage","total"],"properties":{"page":{"type":"integer","minimum":1,"description":"Current page number (1-based).","isRequired":true,"uniqueKey":"meta.pagination.page","typeLabel":"integer"},"perPage":{"type":"integer","minimum":1,"description":"Items per page.","isRequired":true,"uniqueKey":"meta.pagination.perPage","typeLabel":"integer"},"total":{"type":"integer","minimum":0,"description":"Total items across all pages.","isRequired":true,"uniqueKey":"meta.pagination.total","typeLabel":"integer"}},"uniqueKey":"meta.pagination","typeLabel":"object"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"ok":{"title":"ok","value":{"data":{"object":"api_info","apiVersion":"v1","documentationUrl":"https://docs.kychospitality.com"},"meta":{"requestId":"req_01J9Z3K8Q2X7C5N0","timestamp":"2026-06-25T22:01:01.010Z"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c4107427-a052-48b8-8669-032e12a042ef":{"description":"Authentication failed (missing/invalid/expired/unknown key).","headers":{"Kyc-Request-Id":{"description":"Server-generated request ID. Present on every response. Mirrors `meta.requestId`.","schema":{"type":"string"},"example":"req_01J9Z3K8Q2X7C5N0"},"WWW-Authenticate":{"description":"Authentication scheme.","schema":{"type":"string"},"example":"Bearer"}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem+json, enriched. **Every field is always present** — empty scalars are `\"\"`, empty arrays are `[]`. Clients branch on `code`, never on `title`/`detail` text.\n","required":["type","title","status","detail","moreInfo","instance","code","errors","requestId","timestamp"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the docs page for this error code (this IS the documentation reference).","examples":["https://docs.kychospitality.com/errors/guest-not-found"],"isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the error class (stable).","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code, repeated for convenience.","examples":[404],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable detail specific to this occurrence. May change; do not parse.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"moreInfo":{"type":"string","description":"Optional inline troubleshooting tips beyond `detail`. `\"\"` when none.","isRequired":true,"uniqueKey":"moreInfo","typeLabel":"string"},"instance":{"type":"string","description":"Path of the request that produced the error.","examples":["/v1/guests/9c8e1f20-1a2b-3c4d-5e6f-708192a3b4c5"],"isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable error code. Clients branch on this.","examples":["GUEST_NOT_FOUND"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"Field-level problems (populated for 422 validation; `[]` otherwise).","items":{"type":"object","description":"One field-level validation problem inside `ProblemDetails.errors`.","required":["field","code","detail"],"properties":{"field":{"type":"string","description":"Dotted/array path to the offending field.","examples":["email","phones[0].number"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable field-error code.","examples":["INVALID_FORMAT","INVALID_ENUM_VALUE","REQUIRED","OUT_OF_RANGE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation for this field.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"requestId":{"type":"string","description":"Server request ID (mirrors the `Kyc-Request-Id` header).","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"UTC timestamp of the error.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missingAuth":{"title":"missingAuth","value":{"type":"https://docs.kychospitality.com/errors/missing-auth-header","title":"Missing Authorization header","status":401,"detail":"No Authorization header was provided. Send 'Authorization: Bearer \u003ckey>'.","moreInfo":"","instance":"/v1/","code":"MISSING_AUTH_HEADER","errors":[],"requestId":"req_01J9Z3K8Q2X7C5N0","timestamp":"2026-06-25T22:01:01.010Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"946f034c-749e-4b1a-b7c9-8a04209c255e":{"description":"Authenticated, but not allowed (brand/property access, scope, suspended).","headers":{"Kyc-Request-Id":{"description":"Server-generated request ID. Present on every response. Mirrors `meta.requestId`.","schema":{"type":"string"},"example":"req_01J9Z3K8Q2X7C5N0"}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem+json, enriched. **Every field is always present** — empty scalars are `\"\"`, empty arrays are `[]`. Clients branch on `code`, never on `title`/`detail` text.\n","required":["type","title","status","detail","moreInfo","instance","code","errors","requestId","timestamp"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the docs page for this error code (this IS the documentation reference).","examples":["https://docs.kychospitality.com/errors/guest-not-found"],"isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the error class (stable).","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code, repeated for convenience.","examples":[404],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable detail specific to this occurrence. May change; do not parse.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"moreInfo":{"type":"string","description":"Optional inline troubleshooting tips beyond `detail`. `\"\"` when none.","isRequired":true,"uniqueKey":"moreInfo","typeLabel":"string"},"instance":{"type":"string","description":"Path of the request that produced the error.","examples":["/v1/guests/9c8e1f20-1a2b-3c4d-5e6f-708192a3b4c5"],"isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable error code. Clients branch on this.","examples":["GUEST_NOT_FOUND"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"Field-level problems (populated for 422 validation; `[]` otherwise).","items":{"type":"object","description":"One field-level validation problem inside `ProblemDetails.errors`.","required":["field","code","detail"],"properties":{"field":{"type":"string","description":"Dotted/array path to the offending field.","examples":["email","phones[0].number"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable field-error code.","examples":["INVALID_FORMAT","INVALID_ENUM_VALUE","REQUIRED","OUT_OF_RANGE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation for this field.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"requestId":{"type":"string","description":"Server request ID (mirrors the `Kyc-Request-Id` header).","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"UTC timestamp of the error.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"propertyAccessDenied":{"title":"propertyAccessDenied","value":{"type":"https://docs.kychospitality.com/errors/property-access-denied","title":"Property access denied","status":403,"detail":"Your key is not authorized for the requested property.","moreInfo":"","instance":"/v1/rooms/1b2c3d4e-0000-0000-0000-000000000000","code":"PROPERTY_ACCESS_DENIED","errors":[],"requestId":"req_01J9Z3K8Q2X7C5N0","timestamp":"2026-06-25T22:01:01.010Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"74542db7-1a12-413c-8399-764745f70f19":{"description":"The requested representation (Accept header) cannot be produced.","headers":{"Kyc-Request-Id":{"description":"Server-generated request ID. Present on every response. Mirrors `meta.requestId`.","schema":{"type":"string"},"example":"req_01J9Z3K8Q2X7C5N0"}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem+json, enriched. **Every field is always present** — empty scalars are `\"\"`, empty arrays are `[]`. Clients branch on `code`, never on `title`/`detail` text.\n","required":["type","title","status","detail","moreInfo","instance","code","errors","requestId","timestamp"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the docs page for this error code (this IS the documentation reference).","examples":["https://docs.kychospitality.com/errors/guest-not-found"],"isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the error class (stable).","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code, repeated for convenience.","examples":[404],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable detail specific to this occurrence. May change; do not parse.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"moreInfo":{"type":"string","description":"Optional inline troubleshooting tips beyond `detail`. `\"\"` when none.","isRequired":true,"uniqueKey":"moreInfo","typeLabel":"string"},"instance":{"type":"string","description":"Path of the request that produced the error.","examples":["/v1/guests/9c8e1f20-1a2b-3c4d-5e6f-708192a3b4c5"],"isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable error code. Clients branch on this.","examples":["GUEST_NOT_FOUND"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"Field-level problems (populated for 422 validation; `[]` otherwise).","items":{"type":"object","description":"One field-level validation problem inside `ProblemDetails.errors`.","required":["field","code","detail"],"properties":{"field":{"type":"string","description":"Dotted/array path to the offending field.","examples":["email","phones[0].number"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable field-error code.","examples":["INVALID_FORMAT","INVALID_ENUM_VALUE","REQUIRED","OUT_OF_RANGE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation for this field.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"requestId":{"type":"string","description":"Server request ID (mirrors the `Kyc-Request-Id` header).","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"UTC timestamp of the error.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"notAcceptable":{"title":"notAcceptable","value":{"type":"https://docs.kychospitality.com/errors/not-acceptable","title":"Not acceptable","status":406,"detail":"This endpoint only produces application/json. Requested Accept could not be satisfied.","moreInfo":"","instance":"/v1/properties","code":"NOT_ACCEPTABLE","errors":[],"requestId":"req_01J9Z3K8Q2X7C5N0","timestamp":"2026-06-25T22:01:01.010Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"e0723450-6679-48c5-9c75-e117898c647a":{"description":"Rate limit exceeded.","headers":{"Kyc-Request-Id":{"description":"Server-generated request ID. Present on every response. Mirrors `meta.requestId`.","schema":{"type":"string"},"example":"req_01J9Z3K8Q2X7C5N0"},"Retry-After":{"description":"Seconds to wait before retrying. Sent on 429 and 503.","schema":{"type":"integer","minimum":0},"example":30},"RateLimit-Limit":{"description":"Request quota for the window. (Documented now; enforcement later — Decision 13.)","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests remaining in the current window.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the quota resets.","schema":{"type":"integer"}}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem+json, enriched. **Every field is always present** — empty scalars are `\"\"`, empty arrays are `[]`. Clients branch on `code`, never on `title`/`detail` text.\n","required":["type","title","status","detail","moreInfo","instance","code","errors","requestId","timestamp"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the docs page for this error code (this IS the documentation reference).","examples":["https://docs.kychospitality.com/errors/guest-not-found"],"isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the error class (stable).","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code, repeated for convenience.","examples":[404],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable detail specific to this occurrence. May change; do not parse.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"moreInfo":{"type":"string","description":"Optional inline troubleshooting tips beyond `detail`. `\"\"` when none.","isRequired":true,"uniqueKey":"moreInfo","typeLabel":"string"},"instance":{"type":"string","description":"Path of the request that produced the error.","examples":["/v1/guests/9c8e1f20-1a2b-3c4d-5e6f-708192a3b4c5"],"isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable error code. Clients branch on this.","examples":["GUEST_NOT_FOUND"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"Field-level problems (populated for 422 validation; `[]` otherwise).","items":{"type":"object","description":"One field-level validation problem inside `ProblemDetails.errors`.","required":["field","code","detail"],"properties":{"field":{"type":"string","description":"Dotted/array path to the offending field.","examples":["email","phones[0].number"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable field-error code.","examples":["INVALID_FORMAT","INVALID_ENUM_VALUE","REQUIRED","OUT_OF_RANGE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation for this field.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"requestId":{"type":"string","description":"Server request ID (mirrors the `Kyc-Request-Id` header).","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"UTC timestamp of the error.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rateLimited":{"title":"rateLimited","value":{"type":"https://docs.kychospitality.com/errors/rate-limited","title":"Too many requests","status":429,"detail":"Rate limit exceeded. Retry after 30 seconds.","moreInfo":"","instance":"/v1/guests","code":"RATE_LIMITED","errors":[],"requestId":"req_01J9Z3K8Q2X7C5N0","timestamp":"2026-06-25T22:01:01.010Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"010839fa-6069-416d-a381-dcf755835753":{"description":"Unexpected server fault. No internals are leaked; quote the requestId to support. **Body is best-effort:** this `problem+json` is produced only when the application's exception handler is reached. A true crash, or an infra-level failure (e.g. AWS ALB returning 502/504 before the request reaches the app), bypasses this handler — callers MUST tolerate a non-JSON 5xx response and not assume this shape on any 5xx.\n","headers":{"Kyc-Request-Id":{"description":"Server-generated request ID. Present on every response. Mirrors `meta.requestId`.","schema":{"type":"string"},"example":"req_01J9Z3K8Q2X7C5N0"}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem+json, enriched. **Every field is always present** — empty scalars are `\"\"`, empty arrays are `[]`. Clients branch on `code`, never on `title`/`detail` text.\n","required":["type","title","status","detail","moreInfo","instance","code","errors","requestId","timestamp"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the docs page for this error code (this IS the documentation reference).","examples":["https://docs.kychospitality.com/errors/guest-not-found"],"isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the error class (stable).","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code, repeated for convenience.","examples":[404],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable detail specific to this occurrence. May change; do not parse.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"moreInfo":{"type":"string","description":"Optional inline troubleshooting tips beyond `detail`. `\"\"` when none.","isRequired":true,"uniqueKey":"moreInfo","typeLabel":"string"},"instance":{"type":"string","description":"Path of the request that produced the error.","examples":["/v1/guests/9c8e1f20-1a2b-3c4d-5e6f-708192a3b4c5"],"isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable error code. Clients branch on this.","examples":["GUEST_NOT_FOUND"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"Field-level problems (populated for 422 validation; `[]` otherwise).","items":{"type":"object","description":"One field-level validation problem inside `ProblemDetails.errors`.","required":["field","code","detail"],"properties":{"field":{"type":"string","description":"Dotted/array path to the offending field.","examples":["email","phones[0].number"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable field-error code.","examples":["INVALID_FORMAT","INVALID_ENUM_VALUE","REQUIRED","OUT_OF_RANGE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation for this field.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"requestId":{"type":"string","description":"Server request ID (mirrors the `Kyc-Request-Id` header).","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"UTC timestamp of the error.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"internal":{"title":"internal","value":{"type":"https://docs.kychospitality.com/errors/internal-error","title":"Internal server error","status":500,"detail":"An unexpected error occurred. Contact support with the requestId.","moreInfo":"","instance":"/v1/guests","code":"INTERNAL_ERROR","errors":[],"requestId":"req_01J9Z3K8Q2X7C5N0","timestamp":"2026-06-25T22:01:01.010Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"fe4e9daa-f1e7-4205-83d8-fad7b5ac8d87":{"description":"Temporarily unavailable (maintenance/overload). Retry per Retry-After.","headers":{"Kyc-Request-Id":{"description":"Server-generated request ID. Present on every response. Mirrors `meta.requestId`.","schema":{"type":"string"},"example":"req_01J9Z3K8Q2X7C5N0"},"Retry-After":{"description":"Seconds to wait before retrying. Sent on 429 and 503.","schema":{"type":"integer","minimum":0},"example":30}},"content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem+json, enriched. **Every field is always present** — empty scalars are `\"\"`, empty arrays are `[]`. Clients branch on `code`, never on `title`/`detail` text.\n","required":["type","title","status","detail","moreInfo","instance","code","errors","requestId","timestamp"],"properties":{"type":{"type":"string","format":"uri","description":"URL to the docs page for this error code (this IS the documentation reference).","examples":["https://docs.kychospitality.com/errors/guest-not-found"],"isRequired":true,"uniqueKey":"type","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"Short, human-readable summary of the error class (stable).","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","description":"HTTP status code, repeated for convenience.","examples":[404],"isRequired":true,"uniqueKey":"status","typeLabel":"integer"},"detail":{"type":"string","description":"Human-readable detail specific to this occurrence. May change; do not parse.","isRequired":true,"uniqueKey":"detail","typeLabel":"string"},"moreInfo":{"type":"string","description":"Optional inline troubleshooting tips beyond `detail`. `\"\"` when none.","isRequired":true,"uniqueKey":"moreInfo","typeLabel":"string"},"instance":{"type":"string","description":"Path of the request that produced the error.","examples":["/v1/guests/9c8e1f20-1a2b-3c4d-5e6f-708192a3b4c5"],"isRequired":true,"uniqueKey":"instance","typeLabel":"string"},"code":{"type":"string","description":"Stable, machine-readable error code. Clients branch on this.","examples":["GUEST_NOT_FOUND"],"isRequired":true,"uniqueKey":"code","typeLabel":"string"},"errors":{"type":"array","description":"Field-level problems (populated for 422 validation; `[]` otherwise).","items":{"type":"object","description":"One field-level validation problem inside `ProblemDetails.errors`.","required":["field","code","detail"],"properties":{"field":{"type":"string","description":"Dotted/array path to the offending field.","examples":["email","phones[0].number"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"code":{"type":"string","description":"Stable field-error code.","examples":["INVALID_FORMAT","INVALID_ENUM_VALUE","REQUIRED","OUT_OF_RANGE"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"detail":{"type":"string","description":"Human-readable explanation for this field.","isRequired":true,"uniqueKey":"errors.items.[INDEX].detail","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"errors","typeLabel":"object[]"},"requestId":{"type":"string","description":"Server request ID (mirrors the `Kyc-Request-Id` header).","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","description":"UTC timestamp of the error.","isRequired":true,"uniqueKey":"timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"unavailable":{"title":"unavailable","value":{"type":"https://docs.kychospitality.com/errors/service-unavailable","title":"Service unavailable","status":503,"detail":"The service is temporarily unavailable. Retry after 30 seconds.","moreInfo":"","instance":"/v1/properties","code":"SERVICE_UNAVAILABLE","errors":[],"requestId":"req_01J9Z3K8Q2X7C5N0","timestamp":"2026-06-25T22:01:01.010Z"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"68c49776-3b3f-4686-971b-01241367e443":{"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.\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"48f744ac-5663-4212-86f1-93e67270d604":{"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`."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"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.\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"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.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/kych-public-v1.0.yaml"},"subdomain":"kych-api","siteName":"KYCH Public API","title":"Get API info - KYCH Public API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T18:44:53.996Z","originalFileLocation":"api-reference/system/get-api-info.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \u0026quot;am I hitting the right endpoint with a valid key\u0026quot; check.\">\u003cmeta data-mint-head name=\"application-name\" content=\"KYCH Public API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get API info - KYCH Public API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \u0026quot;am I hitting the right endpoint with a valid key\u0026quot; check.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"KYCH Public API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-docs.kychospitality.com/api-reference/system/get-api-info\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kych-api.mintlify.site/_mintlify/api/og/v2?division=System\u0026amp;title=Get+API+info\u0026amp;description=Returns+the+API+version+and+basic+context%2C+and+confirms+your+key+works.+Authenticated+%E2%80%94+use+this+as+a+quick+%22am+I+hitting+the+right+endpoint+with+a+valid+key%22+c\u0026amp;theme=80a3241c891354da48190644\u0026amp;signature=cf1603bc7e8723affb98bd5ba81e5041c67f2c9179efddbde697804923c06959\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get API info - KYCH Public API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \u0026quot;am I hitting the right endpoint with a valid key\u0026quot; check.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kych-api.mintlify.site/_mintlify/api/og/v2?division=System\u0026amp;title=Get+API+info\u0026amp;description=Returns+the+API+version+and+basic+context%2C+and+confirms+your+key+works.+Authenticated+%E2%80%94+use+this+as+a+quick+%22am+I+hitting+the+right+endpoint+with+a+valid+key%22+c\u0026amp;theme=80a3241c891354da48190644\u0026amp;signature=cf1603bc7e8723affb98bd5ba81e5041c67f2c9179efddbde697804923c06959\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/kych-api/bxdh40ZXYcV5JwSd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"KYCH Public API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#007799\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-docs.kychospitality.com/api-reference/system/get-api-info\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/system/get-api-info.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-docs.kychospitality.com/#organization\",\"name\":\"KYCH Public API\",\"url\":\"https://api-docs.kychospitality.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kych-api/12fbZITjhjaHP-wP/logo/KYC_Logo2019_LG.png?fit=max\u0026auto=format\u0026n=12fbZITjhjaHP-wP\u0026q=85\u0026s=cefb1a32385dbab34dc6e5b2ea0d4818\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api-docs.kychospitality.com#website\",\"name\":\"KYCH Public API\",\"url\":\"https://api-docs.kychospitality.com\",\"publisher\":{\"@id\":\"https://api-docs.kychospitality.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info#webpage\",\"url\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info\",\"name\":\"Get API info\",\"description\":\"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \\\"am I hitting the right endpoint with a valid key\\\" check.\",\"dateModified\":\"2026-11-02T18:44:53.996Z\",\"isPartOf\":{\"@id\":\"https://api-docs.kychospitality.com#website\"},\"breadcrumb\":{\"@id\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"KYCH Public API\",\"item\":\"https://api-docs.kychospitality.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get API info\",\"item\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info#apireference\",\"headline\":\"Get API info\",\"name\":\"Get API info\",\"description\":\"Returns the API version and basic context, and confirms your key works. Authenticated — use this as a quick \\\"am I hitting the right endpoint with a valid key\\\" check.\",\"url\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.kychospitality.com/api-reference/system/get-api-info#webpage\"},\"dateModified\":\"2026-11-02T18:44:53.996Z\",\"publisher\":{\"@id\":\"https://api-docs.kychospitality.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api-docs.kychospitality.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"KYCH Public API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"KYCH Public API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/system/get-api-info.md","siteName":"KYCH Public API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/guests"}]},{"tab":"API Reference","pages":[{"group":"System","pages":[{"openapi":"get /","title":"Get API info","href":"/api-reference/system/get-api-info"},{"openapi":"get /health","title":"Health check","description":"Liveness check for monitors and load balancers. **Unauthenticated and minimal by design** — no API key should ever sit in a monitoring tool. Returns only a status; no versions or internals.\n","href":"/api-reference/system/health-check"}]},{"group":"Properties","pages":[{"openapi":"get /properties","title":"List properties","href":"/api-reference/properties/list-properties"},{"openapi":"get /properties/{propertyId}","title":"Get a property","href":"/api-reference/properties/get-a-property"}]},{"group":"Webhooks","pages":[{"openapi":"openapi/kych-public-v1.0.yaml webhook guestcomm.message.created","title":"Guest message created","href":"/api-reference/webhooks/guestcomm-message-created"},{"openapi":"openapi/kych-public-v1.0.yaml webhook webhook.ping","title":"Ping","href":"/api-reference/webhooks/webhook-ping"}]}]}]},"basePath":"","title":"Get API info - KYCH Public API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}