A generic testing sandbox is available on a limited basis for integration testing.In addition, some hotel brands have additional sandbox environments available with their particular configurations.
API Testing
Test modes will be available in the future, similar to how Stripe handles non-production testing.In this mode, you will be able to read data, but all writes will be simulated, though fully validated.
{"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":"getting-started","slug":"/getting-started","pageMetadata":{"title":"Getting Started","description":null,"href":"/getting-started"},"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}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`To get started with the KYC REST API you need a few things.`}),`\n`,_jsx(Heading,{level:`2`,id:`endpoints`,children:`Endpoints`}),`\n`,_jsx(_components.p,{children:`The production API endpoints vary by hotel brand along with global partitions and regions.\nYou will be given the proper endpoint by your KYC contact.`}),`\n`,_jsx(Heading,{level:`2`,id:`paths`,children:`Paths`}),`\n`,_jsxs(_components.p,{children:[`In addition to the URL, each endpoint will have additional path elements, currently:\n/public-api/v1\nAll documentation will be from this point, so /guests will actually be: `,_jsx(_components.a,{href:`https://public-api.greathotel.kych.co/public-api/v1/guests`,children:`https://public-api.greathotel.kych.co/public-api/v1/guests`})]}),`\n`,_jsx(Heading,{level:`2`,id:`sandbox`,children:`Sandbox`}),`\n`,_jsx(_components.p,{children:`A generic testing sandbox is available on a limited basis for integration testing.`}),`\n`,_jsx(_components.p,{children:`In addition, some hotel brands have additional sandbox environments available with their particular configurations.`}),`\n`,_jsx(Heading,{level:`2`,id:`api-testing`,children:`API Testing`}),`\n`,_jsx(_components.p,{children:`Test modes will be available in the future, similar to how Stripe handles non-production testing.`}),`\n`,_jsx(_components.p,{children:`In this mode, you will be able to read data, but all writes will be simulated, though fully validated.`})]})}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":"Getting Started","description":null,"href":"/getting-started"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Endpoints","slug":"endpoints","depth":2,"children":[]},{"title":"Paths","slug":"paths","depth":2,"children":[]},{"title":"Sandbox","slug":"sandbox","depth":2,"children":[]},{"title":"API Testing","slug":"api-testing","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"kych-api","siteName":"KYCH Public API","title":"Getting Started - KYCH Public API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T21:44:05.615Z","originalFileLocation":"getting-started.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=\"Getting Started - 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/getting-started\">\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=Getting+Started\u0026amp;theme=80a3241c891354da48190644\u0026amp;signature=12cebc8f70b85f7dc970076872155fa53f59728c3a23f0f20eeffdccc3c9918c\">\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=\"Getting Started - 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=Getting+Started\u0026amp;theme=80a3241c891354da48190644\u0026amp;signature=12cebc8f70b85f7dc970076872155fa53f59728c3a23f0f20eeffdccc3c9918c\">\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/getting-started\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started.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/getting-started#webpage\",\"url\":\"https://api-docs.kychospitality.com/getting-started\",\"name\":\"Getting Started\",\"dateModified\":\"2026-11-06T21:44:05.615Z\",\"isPartOf\":{\"@id\":\"https://api-docs.kychospitality.com#website\"},\"breadcrumb\":{\"@id\":\"https://api-docs.kychospitality.com/getting-started#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-docs.kychospitality.com/getting-started#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Getting Started\",\"item\":\"https://api-docs.kychospitality.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Getting Started\",\"item\":\"https://api-docs.kychospitality.com/getting-started\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://api-docs.kychospitality.com/getting-started#article\",\"headline\":\"Getting Started\",\"name\":\"Getting Started\",\"url\":\"https://api-docs.kychospitality.com/getting-started\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.kychospitality.com/getting-started#webpage\"},\"dateModified\":\"2026-11-06T21:44:05.615Z\",\"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":"/getting-started.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","description":null,"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":"Getting Started - KYCH Public API","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}