Be sure to read the guides on how to best use the KYC Public API
We love our partners!
Initial version for webhooks.
Welcome
Welcome to KYC and our technical documentation. We’re glad you’re here and these docs exist to help you, your team,
and your tools more easily interact with our platform. We welcome your feedback, so if you have suggestions or feedback,
please email our documentation team at: Documentation@KYCHospitality.com
API Status
The API and Event system is currently in alpha testing and may change over time -
the current system has basic endpoints and functionality.Note that API development is Spec-driven so these docs and specs may run ahead of what has been
deployed.
Introduction
This documentation is about the KYC public APIs and other technical details about the KYC platform.
Getting Help
For additional help with the API system, please send questions to your KYC contact,
or open a Support Ticket by sending email to Support@KYCHospitality.com
Getting Access
To get access to the API, please reach out to your KYC contact.
Definitions
KYC uses a number of specific terms and words throughout the platform and documentation,
so it’s important to know what we mean when we use these words, even if some are industry
standard or might be obvious. See the Definitions page.
{"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":"index","slug":"/","pageMetadata":{"title":"Introduction","description":null,"href":"/index"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,..._provideComponents(),...props.components},{Heading,Tip,Update,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);if(!Update)_missingMdxReference(`Update`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Tip,{children:_jsx(_components.p,{children:`Be sure to read the guides on how to best use the KYC Public API`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`We love our partners!`})}),`\n`,_jsx(Update,{label:`2026-11-01`,id:`2026-11-01`,children:_jsx(_components.p,{children:`Initial version for webhooks.`})}),`\n`,_jsx(Heading,{level:`1`,id:`welcome`,children:`Welcome`}),`\n`,_jsxs(_components.p,{children:[`Welcome to KYC and our technical documentation. We’re glad you’re here and these docs exist to help you, your team,\nand your tools more easily interact with our platform. We welcome your feedback, so if you have suggestions or feedback,\nplease email our documentation team at: `,_jsx(_components.a,{href:`mailto:Documentation@KYCHospitality.com`,children:`Documentation@KYCHospitality.com`})]}),`\n`,_jsx(Heading,{level:`2`,id:`api-status`,children:`API Status`}),`\n`,_jsx(_components.p,{children:`The API and Event system is currently in alpha testing and may change over time -\nthe current system has basic endpoints and functionality.`}),`\n`,_jsx(_components.p,{children:`Note that API development is Spec-driven so these docs and specs may run ahead of what has been\ndeployed.`}),`\n`,_jsx(Heading,{level:`2`,id:`introduction`,children:`Introduction`}),`\n`,_jsx(_components.p,{children:`This documentation is about the KYC public APIs and other technical details about the KYC platform.`}),`\n`,_jsx(Heading,{level:`2`,id:`getting-help`,children:`Getting Help`}),`\n`,_jsxs(_components.p,{children:[`For additional help with the API system, please send questions to your KYC contact,\nor open a Support Ticket by sending email to `,_jsx(_components.a,{href:`mailto:Support@KYCHospitality.com`,children:`Support@KYCHospitality.com`})]}),`\n`,_jsx(Heading,{level:`2`,id:`getting-access`,children:`Getting Access`}),`\n`,_jsx(_components.p,{children:`To get access to the API, please reach out to your KYC contact.`}),`\n`,_jsx(Heading,{level:`2`,id:`definitions`,children:`Definitions`}),`\n`,_jsxs(_components.p,{children:[`KYC uses a number of specific terms and words throughout the platform and documentation,\nso it’s important to know what we mean when we use these words, even if some are industry\nstandard or might be obvious. See the `,_jsx(_components.a,{href:`/definitions`,children:`Definitions`}),` page.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Introduction","description":null,"href":"/index"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"2026-11-01","slug":"2026-11-01","depth":1,"children":[]},{"title":"Welcome","slug":"welcome","depth":1,"children":[]},{"title":"API Status","slug":"api-status","depth":2,"children":[]},{"title":"Introduction","slug":"introduction","depth":2,"children":[]},{"title":"Getting Help","slug":"getting-help","depth":2,"children":[]},{"title":"Getting Access","slug":"getting-access","depth":2,"children":[]},{"title":"Definitions","slug":"definitions","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"kych-api","siteName":"KYCH Public API","title":"Introduction - KYCH Public API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T21:44:05.617Z","originalFileLocation":"index.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=\"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=\"Introduction - KYCH Public API\">\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\">\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=Getting+Started\u0026amp;title=Introduction\u0026amp;theme=80a3241c891354da48190644\u0026amp;signature=e3eeaf543267f237ab33101a490283984d8c5d063bfdfb1ac8272cec788dae07\">\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=\"Introduction - KYCH Public API\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kych-api.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Introduction\u0026amp;theme=80a3241c891354da48190644\u0026amp;signature=e3eeaf543267f237ab33101a490283984d8c5d063bfdfb1ac8272cec788dae07\">\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\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/index.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/#webpage\",\"url\":\"https://api-docs.kychospitality.com/\",\"name\":\"Introduction\",\"dateModified\":\"2026-11-06T21:44:05.617Z\",\"isPartOf\":{\"@id\":\"https://api-docs.kychospitality.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://api-docs.kychospitality.com/#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"url\":\"https://api-docs.kychospitality.com/\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.kychospitality.com/#webpage\"},\"dateModified\":\"2026-11-06T21:44:05.617Z\",\"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":"/index.md","siteName":"KYCH Public API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"group":"Getting Started","pages":[{"title":"Introduction","href":""},{"title":"Overview","description":null,"href":"/overview"},{"title":"Getting Started","href":"/getting-started"}]},{"group":"Authentication \u0026 Security","pages":[{"title":"Authentication","href":"/authentication"},{"title":"Security","href":"/security"}]},{"group":"Core Concepts","pages":[{"title":"Definitions","href":"/definitions"},{"title":"Key Data","href":"/key-data"},{"title":"Personal Information (PII)","href":"/pii"},{"title":"Hotel Data Challenges","href":"/data-challenges"}]},{"group":"Using the API","pages":[{"title":"Using the API","href":"/use-details"},{"title":"API Requests","href":"/api-requests"},{"title":"API Responses","href":"/api-responses"},{"title":"Error Codes","href":"/error-codes"}]},{"group":"Webhooks","pages":[{"title":"Webhooks overview","href":"/webhooks/overview"},{"title":"Verifying signatures","href":"/webhooks/verifying-signatures"},{"title":"Receiver requirements","href":"/webhooks/receiver-requirements"},{"title":"Retries and auto-disable","href":"/webhooks/retries"},{"title":"Legacy v1 payload","href":"/webhooks/legacy-v1"}]}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/guests"}]},{"tab":"API Reference","pages":[{"title":"API Reference","href":"/api-reference/system/get-api-info"}]}]},"basePath":"","title":"Introduction - KYCH Public API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}