Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.
Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Photon","colors":{"primary":"#47c6ed","light":"#47c6ed","dark":"#47c6ed"},"logo":{"light":"https://mintcdn.com/photon-6d78d87b/hMh2hcolREhyGomA/logo/light.svg?fit=max\u0026auto=format\u0026n=hMh2hcolREhyGomA\u0026q=85\u0026s=11512a078b26743f3341822f7095a71d","dark":"https://mintcdn.com/photon-6d78d87b/hMh2hcolREhyGomA/logo/dark.svg?fit=max\u0026auto=format\u0026n=hMh2hcolREhyGomA\u0026q=85\u0026s=0922f188bdc8d783c1460a707ca58215"},"favicon":"https://mintcdn.com/photon-6d78d87b/3zs1WCtLT_oibNcX/favicon-128x128.png?fit=max\u0026auto=format\u0026n=3zs1WCtLT_oibNcX\u0026q=85\u0026s=8c914cde9344878faf68ae81d39414e5","api":{"asyncapi":"https://api.photon.codes/asyncapi.yaml"},"navbar":{"links":[{"href":"https://photon.codes/contact","label":"Contact"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.photon.codes"}},"footer":{"socials":{"x":"https://x.com/photon_hq","github":"https://github.com/photon-hq","linkedin":"https://www.linkedin.com/company/photonhq","discord":"https://discord.gg/4c3VJzDfNA"}},"seo":{"metatags":{"canonical":"https://photon.codes/docs","og:image":"https://photon.codes/docs/images/social-cover.png","og:image:alt":"Photon dashboard on a blue background","twitter:card":"summary_large_image","twitter:image":"https://photon.codes/docs/images/social-cover.png","twitter:image:alt":"Photon dashboard on a blue background"}},"fonts":{"heading":{"family":"PolySansArabicVF","weight":600,"source":"https://photon.codes/docs/fonts/PolySansArabicVF.woff2","format":"woff2"},"body":{"family":"Inter"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"instructions":["Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.","Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.","For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.","The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes."]},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"photon-6d78d87b","hasAudioNarration":false,"actualSubdomain":"photon-6d78d87b","customDomains":["docs.photon.codes"],"gitSource":{"type":"github","owner":"photon-hq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":false,"issues":false,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af185cca4e37073d30c1230","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"Low-level SDKs","count":1029},{"language":"default","tag":"Type reference","count":1009},{"language":"default","tag":"index","count":481},{"language":"default","tag":"chat","count":439},{"language":"default","tag":"Interfaces","count":434},{"language":"default","tag":"API Reference","count":260},{"language":"default","tag":"Endpoints","count":247},{"language":"default","tag":"spectrum-ts","count":235},{"language":"default","tag":"Type Aliases","count":225},{"language":"default","tag":"API Client","count":199}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","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":"llms-txt-v2","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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"/* cyrillic-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrodmgPn.woff2) format('woff2');\n unicode-range: U+0460-052F, U+1C80-1C8A, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\n}\n/* cyrillic */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrMdmgPn.woff2) format('woff2');\n unicode-range: U+0301, U+0400-045F, U+0490-0491, U+04B0-04B1, U+2116;\n}\n/* symbols2 */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFg08vz7ehw.woff2) format('woff2');\n unicode-range: U+2000-2001, U+2004-2008, U+200A, U+23B8-23BD, U+2500-259F;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrgdmgPn.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrkdmgPn.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Geist Mono';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/docs/_mintlify/assets/fonts/google/s/geistmono/v6/or3nQ6H-1_WfwkMZI_qYFrcdmg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n@font-face{font-family:'PolySansArabicVF';src:url('https://photon.codes/docs/fonts/PolySansArabicVF.woff2') format('woff2');font-weight:400;font-display:swap}.mdx-content{font-size:16px;font-weight:400;line-height:28px;letter-spacing:0}#page-title,.mdx-content h1{font-size:36px;font-weight:600;line-height:40px;letter-spacing:-0.2px}.mdx-content h2:not(.not-prose){font-size:24px;font-weight:600;line-height:32px;letter-spacing:0}.mdx-content h3,[data-component-part=\"card-title\"]{font-family:var(--font-family-headings-custom);font-size:20px;font-weight:600;line-height:32px;letter-spacing:0.02em}#header .prose{font-size:18px;font-weight:400;line-height:28px;letter-spacing:-0.02em}.mdx-content strong{font-weight:600}[data-component-part=\"card-content\"],[data-component-part=\"callout-content\"]{font-size:14px;font-weight:400;line-height:24px;letter-spacing:0}.sidebar-group a,.sidebar-group button,.toc a,[data-layout-item=\"search-entry\"]{font-size:14px;font-weight:400;line-height:20px;letter-spacing:0;text-shadow:none}.sidebar-group-header,.nav-tabs-item,.mobile-nav-tabs-item,[data-component-part=\"version-select-trigger\"],#table-of-contents h2,#table-of-contents h2 button{font-family:var(--font-family-body-custom);font-size:14px;font-weight:600;line-height:20px;letter-spacing:0;text-shadow:none}.eyebrow{font-family:'Geist Mono', monospace;font-size:14px;font-weight:400;line-height:20px;letter-spacing:0}.mdx-content figcaption,[data-component-part=\"code-block-header\"],[data-component-part=\"code-group-tab-bar\"] [role=\"tab\"]{font-family:var(--font-family-headings-custom);font-size:12px;font-weight:400;line-height:18px;letter-spacing:0}.mdx-content a.link,[data-component-part=\"card-cta\"]{font-weight:600;letter-spacing:-0.01em}.mdx-content a.link{font-size:inherit;line-height:inherit}[data-component-part=\"card-cta\"]{font-size:14px;line-height:24px}code,pre{font-family:'Geist Mono', monospace!important;font-size:14px!important;line-height:24px!important;letter-spacing:0}code{font-weight:500}pre,pre code{font-weight:400}::-webkit-scrollbar{width:10px;height:10px}::-webkit-scrollbar-track{background:transparent}::-webkit-scrollbar-thumb{background:var(--border, rgba(128, 128, 128, 0.3));border-radius:9999px;border:2px solid transparent;background-clip:content-box}::-webkit-scrollbar-thumb:hover{background:rgba(128, 128, 128, 0.5);border:2px solid transparent;background-clip:content-box}::-webkit-scrollbar-corner{background:transparent}*{scrollbar-width:thin;scrollbar-color:var(--border, rgba(128, 128, 128, 0.3)) transparent}#navbar div:has(>a>.nav-logo){flex:0 0 auto!important}#navbar div[class*=\"ustify-end\"]{margin-left:0!important;flex:0 0 auto!important}#navbar .nav-tabs{column-gap:24px!important}#navbar #topbar-cta-button{position:fixed!important;right:1.75rem!important;top:0!important;height:3.5rem!important;display:flex!important;align-items:center!important}*/\n\n/*#content-container {\n border: 1px solid rgba(255, 255, 255, 0.07) !important;\n background-color: #101010;\n scroll-behavior: smooth !important;\n}\n\n.sidebar-group {\n font-weight: 400 !important;\n}*/\n\n#table-of-contents{scrollbar-width:none}#table-of-contents::-webkit-scrollbar{display:none}#navbar a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]),#navbar li.navbar-link>a[href=\"https://photon.codes/contact\"]{--corner-shape-fallback: 0.945;position:relative!important;display:inline-flex!important;align-items:center!important;justify-content:center!important;corner-shape:superellipse(1.1);border-radius:calc(40px * var(--one-if-corner-shape-supported, var(--corner-shape-fallback, 1)))!important;box-shadow:rgba(255, 255, 255, 0.5) 0px 0px 5px 2px inset!important;border-style:solid!important;border-width:1.5px!important;padding:8px 14px!important;color:rgb(255, 255, 255)!important;font-family:'Inter', sans-serif!important;font-size:14px!important;font-weight:500!important;text-shadow:rgba(128, 128, 128, 0.25) 0px 0px 4px;transition:box-shadow 0.35s ease, transform 0.35s cubic-bezier(0.34, 1.56, 0.64, 1)!important;transform:scale(1)}#navbar a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]):hover,#navbar li.navbar-link>a[href=\"https://photon.codes/contact\"]:hover{box-shadow:rgba(255, 255, 255, 0.5) 0px -2.77px 7.82px 2px inset!important;transform:scale(1.02)!important}#navbar a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]),#navbar li.navbar-link>a[href=\"https://photon.codes/contact\"]{gap:0!important;transition:box-shadow 0.35s ease,\n transform 0.35s cubic-bezier(0.34, 1.56, 0.64, 1),\n gap 0.25s ease!important}#navbar a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]):hover,#navbar li.navbar-link>a[href=\"https://photon.codes/contact\"]:hover{gap:4px!important}#navbar a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"])::after,#navbar li.navbar-link>a[href=\"https://photon.codes/contact\"]::after{content:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' width='20' height='20'%3E%3Cpath d='M 0 0 L 5.5 5.25 L 0 10.5' fill='none' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' stroke='white' transform='translate(13.75 6.75)'/%3E%3Cpath d='M 14.25 0 L 0 0' fill='none' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' stroke='white' transform='translate(4.75 12)'/%3E%3C/svg%3E\");display:inline-block;width:0;height:20px;opacity:0;overflow:hidden;line-height:0;transition:opacity 0.25s ease, width 0.25s ease;vertical-align:middle}#navbar a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]):hover::after,#navbar li.navbar-link>a[href=\"https://photon.codes/contact\"]:hover::after{opacity:1;width:20px}#navbar a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]){background-color:rgb(41, 152, 217)!important;border-color:rgba(41, 152, 217, 0.62)!important;margin-left:8px!important}#navbar li.navbar-link>a[href=\"https://photon.codes/contact\"]{background-color:rgb(0, 0, 0)!important;border-color:rgba(255, 255, 255, 0.62)!important}nav[aria-label=\"Mobile menu\"] a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]){margin-left:0!important}nav[aria-label=\"Mobile menu\"] a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"])::before{display:none}#navbar li.navbar-link:has(>a[href=\"https://photon.codes/contact\"]){position:fixed!important;right:calc(28px + 111px + 8px)!important;top:0!important;height:56px!important;display:flex!important;align-items:center!important;border:none!important;background:transparent!important;padding:0!important;margin:0!important;z-index:10;transition:right 0.25s ease!important}#navbar:has(a:is([href^=\"https://app.photon.codes\"],[href^=\"https://app.beta.photon.codes\"]):hover) li.navbar-link:has(>a[href=\"https://photon.codes/contact\"]){right:calc(28px + 111px + 8px + 24px)!important}nav[aria-label=\"Mobile menu\"] li.navbar-link:has(>a[href=\"https://photon.codes/contact\"]){position:static!important;top:auto!important;right:auto!important;transform:none!important}div:has(>#chat-assistant-sheet){margin-top:56px!important;height:calc(100vh - 56px)!important;top:56px!important}.pt-catalogue{--pt-line: rgba(0, 0, 0, 0.12);--pt-line-soft: rgba(0, 0, 0, 0.07);--pt-header-bg: rgba(255, 255, 255, 0.92);--pt-4xx: rgb(146, 93, 10);--pt-5xx: rgb(176, 42, 42);--pt-accent: rgb(23, 122, 176)}html.dark .pt-catalogue{--pt-line: rgba(255, 255, 255, 0.14);--pt-line-soft: rgba(255, 255, 255, 0.08);--pt-header-bg: rgba(20, 20, 20, 0.85);--pt-4xx: rgb(217, 152, 41);--pt-5xx: rgb(217, 84, 84);--pt-accent: rgb(71, 198, 237)}.pt-controls{display:flex;gap:8px;margin:1rem 0 0.75rem;flex-wrap:wrap}.pt-search{flex:1 1 20rem;min-width:0}.pt-search,.pt-group{padding:7px 11px;border-radius:8px;border:1px solid var(--pt-line);background:transparent;color:inherit;font-size:0.875rem}.pt-search:focus,.pt-group:focus{outline:none;border-color:var(--pt-accent)}.pt-group{cursor:pointer}.pt-catalogue{width:100%}.pt-scroll{overflow-x:auto;border:1px solid var(--pt-line);border-radius:8px}.pt-table{width:100%;border-collapse:collapse;font-size:0.875rem;margin:0}.pt-table th,.pt-table td{text-align:left;padding:8px 12px;vertical-align:top;border-bottom:1px solid var(--pt-line-soft)}.pt-table tbody tr:last-child td{border-bottom:none}.pt-table th{position:sticky;top:0;z-index:1;font-weight:500;white-space:nowrap;background:var(--pt-header-bg)}.pt-sortable{cursor:pointer;user-select:none}.pt-arrow{display:inline-block;width:1em;opacity:0.7}.pt-table code{white-space:nowrap;font-size:0.8125rem}.pt-table th:nth-child(1),.pt-table th:nth-child(2),.pt-table th:nth-child(3){width:1%;white-space:nowrap}.pt-4xx{color:var(--pt-4xx)}.pt-5xx{color:var(--pt-5xx)}.pt-meta{opacity:0.7}.pt-target td{background:color-mix(in srgb, var(--pt-accent) 14%, transparent)}.pt-target td:first-child{box-shadow:inset 2px 0 0 var(--pt-accent)}.pt-count,.pt-empty{font-size:0.8125rem;opacity:0.65;margin-top:0.6rem}.pt-row{scroll-margin-top:96px}:root{--docs-stable-icon: url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2024%2024%22%20fill%3D%22none%22%20stroke%3D%22black%22%20stroke-width%3D%222%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%3E%3Cpath%20d%3D%22M15%203a6%206%200%200%200-6%208l-6%206a2.8%202.8%200%200%200%204%204l6-6a6%206%200%200%200%208-6l-4%203-5-5%203-4Z%22%2F%3E%3C%2Fsvg%3E\");--docs-beta-icon: url(\"data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2024%2024%22%20fill%3D%22none%22%20stroke%3D%22black%22%20stroke-width%3D%222%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%3E%3Cpath%20d%3D%22M9%203h6m-5%200v6l-5.5%209.4A1.7%201.7%200%200%200%206%2021h12a1.7%201.7%200%200%200%201.5-2.6L14%209V3M8%2014h8%22%2F%3E%3C%2Fsvg%3E\")}[data-component-part=\"version-select-trigger\"],[data-component-part=\"version-select-item\"]:nth-child(1){--docs-version-icon: var(--docs-stable-icon)}html:is([data-current-path=\"/beta\"],[data-current-path^=\"/beta/\"]) [data-component-part=\"version-select-trigger\"],[data-component-part=\"version-select-item\"]:nth-child(2){--docs-version-icon: var(--docs-beta-icon)}[data-component-part=\"version-select-trigger\"]::before,[data-component-part=\"version-select-item\"]::before{content:\"\";display:block;flex:0 0 1rem;width:1rem;height:1rem;background-color:currentColor;mask:var(--docs-version-icon) center / contain no-repeat}html[data-current-path=\"/beta/changelog\"] #content-area{--content-width: 44rem}"}],"page":{"pagePath":"beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp","slug":"/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp","pageMetadata":{"title":"Verify sole-proprietor OTP","description":"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/organizations/{organization_id}/10dlc/brands/{brandId}/otp","href":"/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp","autogeneratedByOpenApi":true},"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: \"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.\"\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":{"title":"Verify sole-proprietor OTP","description":"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/organizations/{organization_id}/10dlc/brands/{brandId}/otp","href":"/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/photon-6d78d87b/8a01e78c178e74c3/dashboard-links.js"],"openApiReferenceData":{"operation":{"description":"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.","operationId":"verifyTenDlcBrandOtp","parameters":["0cd6d34f-ceb0-470a-982b-c10634f469f9","ef8812fb-0c5a-478e-8b1b-1c3f8a25c319","e4b88591-1ac2-4b64-bee3-7ede6849676a"],"requestBody":"6f902952-b5d9-42f1-9182-d74bbc1451ba","responses":{"200":"35bcee24-2c05-4925-a825-824bfb7aa50a","400":"91913046-1b69-4104-87d4-2e36b61f164a","401":"c59c8ae7-40ac-43b0-ac27-c3f4b51b75c5","403":"6de4d8b8-9eb6-4d67-8823-e445ecd4e48e","404":"4b52ccae-b135-412b-b7f4-645c2b7fbfca","409":"ca7fe336-2664-4701-bcd2-468301c4e0f4","413":"e0cd6e1d-f765-47d5-8248-bf6035736015","422":"de00b9d9-a84f-4668-84e8-facd91d685d9","429":"032d43e7-0b17-44ec-8343-8015a7b324f8","500":"f846ff1a-a968-4f44-900d-2859452cc4a6","502":"8eae3dcc-a689-49e0-bf41-711edcddd788","503":"869234c8-dbb4-45c4-b285-3bec5bd560b9","504":"1ed635ea-9913-42e1-af88-00bbe08847e5"},"security":["3bc0626e-f421-4cd0-8cae-96c81cce2f2a","7cf80627-59c1-471b-97f6-8252f168d11e","30deec71-595b-4875-8692-b5966997ce75"],"summary":"Verify sole-proprietor OTP","tags":["10DLC brand OTP"],"x-photon-mcp":{"enabled":false},"x-required-permissions":["ten_dlc:write"],"method":"put","type":"path","servers":["e07103a3-aa31-4711-bf7b-d0028e813cc9"],"path":"/v1/organizations/{organization_id}/10dlc/brands/{brandId}/otp","baseUrlOptions":["https://api.photon.codes"],"title":"Verify sole-proprietor OTP","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"0cd6d34f-ceb0-470a-982b-c10634f469f9":{"description":"Identifies one logical mutation across retries.","in":"header","name":"Idempotency-Key","required":true,"schema":{"maxLength":255,"minLength":1,"pattern":"^[\\x21-\\x7e]{1,255}$","type":"string","isRequired":true,"description":"Identifies one logical mutation across retries.","uniqueKey":"","typeLabel":"string"}},"ef8812fb-0c5a-478e-8b1b-1c3f8a25c319":{"in":"path","name":"brandId","required":true,"schema":{"pattern":"^pho_brd_[0-9a-z]{26}$","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"e4b88591-1ac2-4b64-bee3-7ede6849676a":{"in":"path","name":"organization_id","required":true,"schema":{"pattern":"^pho_org_[0-9a-z]{26}$","type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"otpPin":{"maxLength":10,"minLength":4,"pattern":"^[A-Za-z0-9]+$","type":"string","isRequired":true,"uniqueKey":"otpPin","typeLabel":"string"}},"required":["otpPin"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"otpPin":"\u003cstring>"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"35bcee24-2c05-4925-a825-824bfb7aa50a":{"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"data":{"additionalProperties":false,"properties":{"brandId":{"type":"string","isRequired":true,"uniqueKey":"data.brandId","typeLabel":"string"},"phoneLast4":{"maxLength":4,"minLength":4,"type":"string","isRequired":true,"uniqueKey":"data.phoneLast4","typeLabel":"string"},"status":{"enum":["not_requested","delivery_pending","sent","verified","expired","failed","locked"],"type":"string","isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"attemptsRemaining":{"maximum":9007199254740991,"minimum":0,"type":"integer","uniqueKey":"data.attemptsRemaining","typeLabel":"integer"},"expiresAt":{"example":"2026-01-01T00:00:00.000Z","format":"date-time","type":"string","uniqueKey":"data.expiresAt","typeLabel":"string\u003cdate-time>"},"retryAfterSeconds":{"maximum":9007199254740991,"minimum":0,"type":"integer","uniqueKey":"data.retryAfterSeconds","typeLabel":"integer"}},"required":["brandId","phoneLast4","status"],"type":"object","isRequired":true,"uniqueKey":"data","typeLabel":"object"}},"required":["data"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"brandId":"\u003cstring>","phoneLast4":"\u003cstring>","status":"not_requested","attemptsRemaining":4503599627370495,"expiresAt":"2026-01-01T00:00:00.000Z","retryAfterSeconds":4503599627370495}}}},"exampleType":"generated"}},"description":"The updated redacted OTP status.","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"91913046-1b69-4104-87d4-2e36b61f164a":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["code","status","title","type"],"example":{"code":"IDEMPOTENCY_KEY_REQUIRED","status":400,"title":"Idempotency Key Required","type":"https://photon.codes/docs/problems/idempotency-key-required"},"properties":{"code":{"const":"IDEMPOTENCY_KEY_REQUIRED","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"status":{"const":400,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Idempotency Key Required","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/idempotency-key-required","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"IDEMPOTENCY_KEY_INVALID","status":400,"title":"Idempotency Key Invalid","type":"https://photon.codes/docs/problems/idempotency-key-invalid"},"properties":{"code":{"const":"IDEMPOTENCY_KEY_INVALID","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":400,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"Idempotency Key Invalid","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/idempotency-key-invalid","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"IDEMPOTENCY_KEY_REQUIRED","status":400,"title":"Idempotency Key Required","type":"https://photon.codes/docs/problems/idempotency-key-required"}}},"exampleType":"generated"}},"description":"IDEMPOTENCY_KEY_REQUIRED: Idempotency Key Required; IDEMPOTENCY_KEY_INVALID: Idempotency Key Invalid","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"c59c8ae7-40ac-43b0-ac27-c3f4b51b75c5":{"content":{"application/problem+json":{"schema":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"example":{"code":"NOT_AUTHENTICATED","status":401,"title":"Not Authenticated","type":"https://photon.codes/docs/problems/not-authenticated"},"properties":{"code":{"const":"NOT_AUTHENTICATED","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"const":401,"type":"number","isRequired":true,"uniqueKey":"status","typeLabel":"number"},"title":{"const":"Not Authenticated","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/not-authenticated","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"NOT_AUTHENTICATED","status":401,"title":"Not Authenticated","type":"https://photon.codes/docs/problems/not-authenticated"}}},"exampleType":"generated"}},"description":"NOT_AUTHENTICATED: Not Authenticated","headers":{"Link":{"description":"Optional related resources.","schema":{"type":"string"}},"RateLimit":{"description":"Optional rate limit information.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Optional rate limit policy.","schema":{"type":"string"}},"Retry-After":{"description":"Optional retry delay or HTTP date.","schema":{"type":"string"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string"}},"X-Request-ID":{"description":"Application request identifier.","schema":{"type":"string"}}},"exampleType":"generated"},"6de4d8b8-9eb6-4d67-8823-e445ecd4e48e":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["code","status","title","type"],"example":{"code":"FORBIDDEN","status":403,"title":"Forbidden","type":"https://photon.codes/docs/problems/forbidden"},"properties":{"code":{"const":"FORBIDDEN","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"status":{"const":403,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Forbidden","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/forbidden","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"INSUFFICIENT_SCOPE","status":403,"title":"Insufficient Scope","type":"https://photon.codes/docs/problems/insufficient-scope"},"properties":{"code":{"const":"INSUFFICIENT_SCOPE","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":403,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"Insufficient Scope","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/insufficient-scope","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"ORGANIZATION_SSO_REQUIRED","status":403,"title":"Organization SSO Required","type":"https://photon.codes/docs/problems/organization-sso-required"},"properties":{"code":{"const":"ORGANIZATION_SSO_REQUIRED","type":"string","isRequired":true,"uniqueKey":"oneOf.2.code","typeLabel":"string"},"status":{"const":403,"type":"number","isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"number"},"title":{"const":"Organization SSO Required","type":"string","isRequired":true,"uniqueKey":"oneOf.2.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/organization-sso-required","type":"string","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.2.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.2.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.2.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.2.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.2.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.2.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.2.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.2.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.2.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"RESOURCE_MISMATCH","status":403,"title":"Resource Mismatch","type":"https://photon.codes/docs/problems/resource-mismatch"},"properties":{"code":{"const":"RESOURCE_MISMATCH","type":"string","isRequired":true,"uniqueKey":"oneOf.3.code","typeLabel":"string"},"status":{"const":403,"type":"number","isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"number"},"title":{"const":"Resource Mismatch","type":"string","isRequired":true,"uniqueKey":"oneOf.3.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/resource-mismatch","type":"string","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.3.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.3.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.3.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.3.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.3.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.3.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.3.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.3.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.3.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"FORBIDDEN","status":403,"title":"Forbidden","type":"https://photon.codes/docs/problems/forbidden"}}},"exampleType":"generated"}},"description":"FORBIDDEN: Forbidden; RESOURCE_MISMATCH: Resource Mismatch\n\nFORBIDDEN: Forbidden; INSUFFICIENT_SCOPE: Insufficient Scope; ORGANIZATION_SSO_REQUIRED: Organization SSO Required","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.\n\nOptional related resources.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.\n\nOptional rate limit information.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.\n\nOptional rate limit policy.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.\n\nOptional retry delay or HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.\n\nApplication request identifier.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"4b52ccae-b135-412b-b7f4-645c2b7fbfca":{"content":{"application/problem+json":{"schema":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"example":{"code":"BRAND_NOT_FOUND","status":404,"title":"Brand Not Found","type":"https://photon.codes/docs/problems/brand-not-found"},"properties":{"code":{"const":"BRAND_NOT_FOUND","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"const":404,"type":"number","isRequired":true,"uniqueKey":"status","typeLabel":"number"},"title":{"const":"Brand Not Found","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/brand-not-found","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"BRAND_NOT_FOUND","status":404,"title":"Brand Not Found","type":"https://photon.codes/docs/problems/brand-not-found"}}},"exampleType":"generated"}},"description":"BRAND_NOT_FOUND: Brand Not Found","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"ca7fe336-2664-4701-bcd2-468301c4e0f4":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["code","status","title","type"],"example":{"code":"IDEMPOTENCY_CONFLICT","status":409,"title":"Idempotency Conflict","type":"https://photon.codes/docs/problems/idempotency-conflict"},"properties":{"code":{"const":"IDEMPOTENCY_CONFLICT","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"status":{"const":409,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Idempotency Conflict","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/idempotency-conflict","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"INVALID_LIFECYCLE_STATE","status":409,"title":"Invalid Lifecycle State","type":"https://photon.codes/docs/problems/invalid-lifecycle-state"},"properties":{"code":{"const":"INVALID_LIFECYCLE_STATE","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":409,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"Invalid Lifecycle State","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/invalid-lifecycle-state","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"ORGANIZATION_CLOSING","status":409,"title":"Organization is closing","type":"https://photon.codes/docs/problems/organization-closing"},"properties":{"code":{"const":"ORGANIZATION_CLOSING","type":"string","isRequired":true,"uniqueKey":"oneOf.2.code","typeLabel":"string"},"status":{"const":409,"type":"number","isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"number"},"title":{"const":"Organization is closing","type":"string","isRequired":true,"uniqueKey":"oneOf.2.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/organization-closing","type":"string","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.2.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.2.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.2.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.2.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.2.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.2.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.2.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.2.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.2.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"OTP_LOCKED","status":409,"title":"OTP Locked","type":"https://photon.codes/docs/problems/otp-locked"},"properties":{"code":{"const":"OTP_LOCKED","type":"string","isRequired":true,"uniqueKey":"oneOf.3.code","typeLabel":"string"},"status":{"const":409,"type":"number","isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"number"},"title":{"const":"OTP Locked","type":"string","isRequired":true,"uniqueKey":"oneOf.3.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/otp-locked","type":"string","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.3.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.3.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.3.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.3.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.3.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.3.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.3.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.3.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.3.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"IDEMPOTENCY_CONFLICT","status":409,"title":"Idempotency Conflict","type":"https://photon.codes/docs/problems/idempotency-conflict"}}},"exampleType":"generated"}},"description":"IDEMPOTENCY_CONFLICT: Idempotency Conflict; INVALID_LIFECYCLE_STATE: Invalid Lifecycle State; ORGANIZATION_CLOSING: Organization is closing; OTP_LOCKED: OTP Locked","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"e0cd6e1d-f765-47d5-8248-bf6035736015":{"content":{"application/problem+json":{"schema":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"example":{"code":"PAYLOAD_TOO_LARGE","status":413,"title":"Payload Too Large","type":"https://photon.codes/docs/problems/payload-too-large"},"properties":{"code":{"const":"PAYLOAD_TOO_LARGE","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"const":413,"type":"number","isRequired":true,"uniqueKey":"status","typeLabel":"number"},"title":{"const":"Payload Too Large","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/payload-too-large","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"PAYLOAD_TOO_LARGE","status":413,"title":"Payload Too Large","type":"https://photon.codes/docs/problems/payload-too-large"}}},"exampleType":"generated"}},"description":"PAYLOAD_TOO_LARGE: Payload Too Large","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"de00b9d9-a84f-4668-84e8-facd91d685d9":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["issues","code","status","title","type"],"example":{"code":"VALIDATION_FAILED","issues":[{"code":"invalid_type","location":"json","message":"Expected a string.","path":"/name"}],"status":422,"title":"Request Validation Failed","type":"https://photon.codes/docs/problems/validation-failed"},"properties":{"code":{"const":"VALIDATION_FAILED","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"issues":{"items":{"additionalProperties":false,"properties":{"code":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.issues.items.[INDEX].code","typeLabel":"string"},"location":{"enum":["body","cookie","form","header","json","param","query"],"type":"string","isRequired":true,"uniqueKey":"oneOf.0.issues.items.[INDEX].location","typeLabel":"enum\u003cstring>"},"message":{"minLength":1,"type":"string","isRequired":true,"uniqueKey":"oneOf.0.issues.items.[INDEX].message","typeLabel":"string"},"path":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.issues.items.[INDEX].path","typeLabel":"string"}},"required":["code","location","message","path"],"type":"object","uniqueKey":"oneOf.0.issues.items.[INDEX]","typeLabel":"object"},"type":"array","isRequired":true,"uniqueKey":"oneOf.0.issues","typeLabel":"object[]"},"status":{"const":422,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Request Validation Failed","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/validation-failed","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"IDEMPOTENCY_KEY_REUSED","status":422,"title":"Idempotency Key Reused","type":"https://photon.codes/docs/problems/idempotency-key-reused"},"properties":{"code":{"const":"IDEMPOTENCY_KEY_REUSED","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":422,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"Idempotency Key Reused","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/idempotency-key-reused","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"UNSUPPORTED_ENTITY_TYPE","status":422,"title":"Unsupported Entity Type","type":"https://photon.codes/docs/problems/unsupported-entity-type"},"properties":{"code":{"const":"UNSUPPORTED_ENTITY_TYPE","type":"string","isRequired":true,"uniqueKey":"oneOf.2.code","typeLabel":"string"},"status":{"const":422,"type":"number","isRequired":true,"uniqueKey":"oneOf.2.status","typeLabel":"number"},"title":{"const":"Unsupported Entity Type","type":"string","isRequired":true,"uniqueKey":"oneOf.2.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/unsupported-entity-type","type":"string","isRequired":true,"uniqueKey":"oneOf.2.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.2.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.2.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.2.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.2.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.2.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.2.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.2.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.2.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.2.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.2.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"PHONE_NOT_SMS_CAPABLE","status":422,"title":"Phone Is Not SMS Capable","type":"https://photon.codes/docs/problems/phone-not-sms-capable"},"properties":{"code":{"const":"PHONE_NOT_SMS_CAPABLE","type":"string","isRequired":true,"uniqueKey":"oneOf.3.code","typeLabel":"string"},"status":{"const":422,"type":"number","isRequired":true,"uniqueKey":"oneOf.3.status","typeLabel":"number"},"title":{"const":"Phone Is Not SMS Capable","type":"string","isRequired":true,"uniqueKey":"oneOf.3.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/phone-not-sms-capable","type":"string","isRequired":true,"uniqueKey":"oneOf.3.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.3.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.3.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.3.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.3.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.3.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.3.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.3.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.3.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.3.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.3.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.3","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"OTP_VERIFICATION_REJECTED","status":422,"title":"OTP Verification Rejected","type":"https://photon.codes/docs/problems/otp-verification-rejected"},"properties":{"code":{"const":"OTP_VERIFICATION_REJECTED","type":"string","isRequired":true,"uniqueKey":"oneOf.4.code","typeLabel":"string"},"status":{"const":422,"type":"number","isRequired":true,"uniqueKey":"oneOf.4.status","typeLabel":"number"},"title":{"const":"OTP Verification Rejected","type":"string","isRequired":true,"uniqueKey":"oneOf.4.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/otp-verification-rejected","type":"string","isRequired":true,"uniqueKey":"oneOf.4.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.4.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.4.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.4.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.4.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.4.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.4.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.4.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.4.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.4.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.4.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.4.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.4.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.4","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"VALIDATION_FAILED","issues":[{"code":"invalid_type","location":"json","message":"Expected a string.","path":"/name"}],"status":422,"title":"Request Validation Failed","type":"https://photon.codes/docs/problems/validation-failed"}}},"exampleType":"generated"}},"description":"VALIDATION_FAILED: Request Validation Failed; IDEMPOTENCY_KEY_REUSED: Idempotency Key Reused; UNSUPPORTED_ENTITY_TYPE: Unsupported Entity Type; PHONE_NOT_SMS_CAPABLE: Phone Is Not SMS Capable; OTP_VERIFICATION_REJECTED: OTP Verification Rejected","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"032d43e7-0b17-44ec-8343-8015a7b324f8":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["code","status","title","type"],"example":{"code":"RATE_LIMITED","status":429,"title":"Too Many Requests","type":"https://photon.codes/docs/problems/rate-limited"},"properties":{"code":{"const":"RATE_LIMITED","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"status":{"const":429,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Too Many Requests","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/rate-limited","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"OTP_RATE_LIMITED","status":429,"title":"OTP Rate Limited","type":"https://photon.codes/docs/problems/otp-rate-limited"},"properties":{"code":{"const":"OTP_RATE_LIMITED","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":429,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"OTP Rate Limited","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/otp-rate-limited","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"RATE_LIMITED","status":429,"title":"Too Many Requests","type":"https://photon.codes/docs/problems/rate-limited"}}},"exampleType":"generated"}},"description":"RATE_LIMITED: Too Many Requests; OTP_RATE_LIMITED: OTP Rate Limited","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"f846ff1a-a968-4f44-900d-2859452cc4a6":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["code","status","title","type"],"example":{"code":"INTERNAL_ERROR","status":500,"title":"Internal Server Error","type":"https://photon.codes/docs/problems/internal-error"},"properties":{"code":{"const":"INTERNAL_ERROR","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"status":{"const":500,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Internal Server Error","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/internal-error","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"INVALID_AUTH_CONTEXT","status":500,"title":"Invalid Authentication Context","type":"https://photon.codes/docs/problems/invalid-auth-context"},"properties":{"code":{"const":"INVALID_AUTH_CONTEXT","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":500,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"Invalid Authentication Context","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/invalid-auth-context","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"INTERNAL_ERROR","status":500,"title":"Internal Server Error","type":"https://photon.codes/docs/problems/internal-error"}}},"exampleType":"generated"}},"description":"INVALID_AUTH_CONTEXT: Invalid Authentication Context\n\nINTERNAL_ERROR: Internal Server Error","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.\n\nOptional related resources.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.\n\nOptional rate limit information.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.\n\nOptional rate limit policy.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.\n\nOptional retry delay or HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.\n\nApplication request identifier.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"8eae3dcc-a689-49e0-bf41-711edcddd788":{"content":{"application/problem+json":{"schema":{"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"example":{"code":"SERVICE_FAILURE","status":502,"title":"Service Failure","type":"https://photon.codes/docs/problems/service-failure"},"properties":{"code":{"const":"SERVICE_FAILURE","type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"status":{"const":502,"type":"number","isRequired":true,"uniqueKey":"status","typeLabel":"number"},"title":{"const":"Service Failure","type":"string","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/service-failure","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"requestId","typeLabel":"string"}},"required":["code","status","title","type"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"SERVICE_FAILURE","status":502,"title":"Service Failure","type":"https://photon.codes/docs/problems/service-failure"}}},"exampleType":"generated"}},"description":"SERVICE_FAILURE: Service Failure","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"869234c8-dbb4-45c4-b285-3bec5bd560b9":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["code","status","title","type"],"example":{"code":"SERVICE_UNAVAILABLE","status":503,"title":"Service Temporarily Unavailable","type":"https://photon.codes/docs/problems/service-unavailable"},"properties":{"code":{"const":"SERVICE_UNAVAILABLE","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"status":{"const":503,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Service Temporarily Unavailable","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/service-unavailable","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"UPSTREAM_UNAVAILABLE","status":503,"title":"Upstream Service Unavailable","type":"https://photon.codes/docs/problems/upstream-unavailable"},"properties":{"code":{"const":"UPSTREAM_UNAVAILABLE","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":503,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"Upstream Service Unavailable","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/upstream-unavailable","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"SERVICE_UNAVAILABLE","status":503,"title":"Service Temporarily Unavailable","type":"https://photon.codes/docs/problems/service-unavailable"}}},"exampleType":"generated"}},"description":"SERVICE_UNAVAILABLE: Service Temporarily Unavailable\n\nUPSTREAM_UNAVAILABLE: Upstream Service Unavailable","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.\n\nOptional related resources.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.\n\nOptional rate limit information.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.\n\nOptional rate limit policy.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.\n\nOptional retry delay or HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.\n\nApplication request identifier.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"},"1ed635ea-9913-42e1-af88-00bbe08847e5":{"content":{"application/problem+json":{"schema":{"oneOf":[{"type":"object","required":["code","status","title","type"],"example":{"code":"REQUEST_TIMEOUT","status":504,"title":"Request Timeout","type":"https://photon.codes/docs/problems/request-timeout"},"properties":{"code":{"const":"REQUEST_TIMEOUT","type":"string","isRequired":true,"uniqueKey":"oneOf.0.code","typeLabel":"string"},"status":{"const":504,"type":"number","isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"number"},"title":{"const":"Request Timeout","type":"string","isRequired":true,"uniqueKey":"oneOf.0.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/request-timeout","type":"string","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.0.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.0.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.0.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.0.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.0.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.0.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.0.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["code","status","title","type"],"example":{"code":"SERVICE_TIMEOUT","status":504,"title":"Service Timeout","type":"https://photon.codes/docs/problems/service-timeout"},"properties":{"code":{"const":"SERVICE_TIMEOUT","type":"string","isRequired":true,"uniqueKey":"oneOf.1.code","typeLabel":"string"},"status":{"const":504,"type":"number","isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"number"},"title":{"const":"Service Timeout","type":"string","isRequired":true,"uniqueKey":"oneOf.1.title","typeLabel":"string"},"type":{"const":"https://photon.codes/docs/problems/service-timeout","type":"string","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"string"},"detail":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.detail","typeLabel":"string"},"instance":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.instance","typeLabel":"string"},"remediation":{"oneOf":[{"not":{}}],"uniqueKey":"oneOf.1.remediation","typeLabel":"any"},"requestId":{"minLength":1,"type":"string","uniqueKey":"oneOf.1.requestId","typeLabel":"string"}},"additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"},{"type":"null","uniqueKey":"oneOf.1.additionalProperties.oneOf.3","typeLabel":"null"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.additionalProperties.oneOf.4","typeLabel":"any[]"},{"type":"object","uniqueKey":"oneOf.1.additionalProperties.oneOf.5","typeLabel":"object"}],"uniqueKey":"oneOf.1.additionalProperties","typeLabel":"string | number | boolean | null | any[] | object"},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"REQUEST_TIMEOUT","status":504,"title":"Request Timeout","type":"https://photon.codes/docs/problems/request-timeout"}}},"exampleType":"generated"}},"description":"REQUEST_TIMEOUT: Request Timeout; SERVICE_TIMEOUT: Service Timeout","headers":{"Deprecation":{"description":"RFC 9745 structured-field Date at which the operation was or will be deprecated: `@` followed by Unix seconds, for example `@1767225599`.","schema":{"pattern":"^@-?[0-9]+$","type":"string"}},"Idempotent-Replayed":{"description":"True when this response was replayed from an earlier attempt.","schema":{"type":"boolean"}},"Link":{"description":"Links related to lifecycle or remediation documentation.","schema":{"type":"string"}},"RateLimit":{"description":"Current rate-limit state.","schema":{"type":"string"}},"RateLimit-Policy":{"description":"Rate-limit policy applied by the gateway.","schema":{"type":"string"}},"Retry-After":{"description":"Delay before retrying, in seconds or as an HTTP date.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 HTTP-date (IMF-fixdate) after which the operation may become unavailable, for example `Thu, 31 Dec 2026 23:59:59 GMT`.","schema":{"pattern":"^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), [0-9]{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) [0-9]{4} [0-9]{2}:[0-9]{2}:[0-9]{2} GMT$","type":"string"}},"X-Request-ID":{"description":"Identifier for this HTTP attempt.","schema":{"type":"string"}},"X-Trace-ID":{"description":"Trace ID of this request. Sent alongside X-Request-ID when a middleware published a trace ID for the request.","schema":{"pattern":"^(?!0{32}$)[0-9a-f]{32}$","type":"string"}}},"exampleType":"generated"}},"security":{"3bc0626e-f421-4cd0-8cae-96c81cce2f2a":{"accountServiceKey":{"description":"Account Service Key, prefixed with `pho_ask_`, sent as `Authorization: Bearer \u003ckey>`. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.","scheme":"bearer","type":"http","scopes":[],"schemeName":"accountServiceKey"}},"7cf80627-59c1-471b-97f6-8252f168d11e":{"serviceIdentityBearer":{"description":"Organization Service Identity API key or M2M access token, sent as `Authorization: Bearer \u003ccredential>`. Restricted to its organization and explicitly granted business permissions. It does not authorize human organization governance or Photon credential management. Never send an M2M client secret to a business endpoint.","scheme":"bearer","type":"http","scopes":[],"schemeName":"serviceIdentityBearer"}},"30deec71-595b-4875-8692-b5966997ce75":{"oauth2":{"description":"OAuth grant issued by the Photon authorization server. The token is a bearer JWT whose consented scope is intersected with the permissions the route grants; an empty intersection is `403 insufficient_scope`.","flows":{"authorizationCode":{"authorizationUrl":"https://auth.photon.codes/oauth2/authorize","scopes":{"account:create_project":"Create a project owned by the account.","account:read":"View account profile.","account:read_projects":"List projects associated with the account; does not grant access to project contents.","account:write":"Update account name and profile.","billing:read":"View invoices, usage, payment status.","calls:read":"Read project call data and lifecycle events via supported APIs or approved subscriptions; excludes stored Events queries.","events:read":"Query stored Events and discover their SQL schema within a project.","messages:read":"Read project messages, delivery status, participant changes and typing activity via supported APIs or approved subscriptions.","organization:create_project":"Create a project in the organization.","organization:read":"View organization name and avatar.","organization:read_projects":"List projects in the organization.","platforms:read":"View project platform configuration.","platforms:write":"Change project platform configuration.","project:delete":"Permanently delete the project.","project:read":"View non-sensitive project settings.","project:read_usage":"View project usage and costs.","project:write":"Change agent profiles, webhook settings, and other project configuration.","ten_dlc:read":"View organization 10DLC Brand and Campaign registration records.","ten_dlc:write":"Register and update organization 10DLC Brands and Campaigns, including OTP operations."},"tokenUrl":"https://auth.photon.codes/oauth2/token"}},"type":"oauth2","scopes":["ten_dlc:write"],"schemeName":"oauth2"}}},"servers":{"e07103a3-aa31-4711-bf7b-d0028e813cc9":{"url":"https://api.photon.codes"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Account Service Key, prefixed with `pho_ask_`, sent as `Authorization: Bearer \u003ckey>`. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.","scheme":"bearer","type":"http","scopes":[],"schemeName":"accountServiceKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Account Service Key, prefixed with `pho_ask_`, sent as `Authorization: Bearer \u003ckey>`. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"accountServiceKey","name":"Authorization"}],"title":"accountServiceKey"},{"schemes":[{"scheme":{"description":"Organization Service Identity API key or M2M access token, sent as `Authorization: Bearer \u003ccredential>`. Restricted to its organization and explicitly granted business permissions. It does not authorize human organization governance or Photon credential management. Never send an M2M client secret to a business endpoint.","scheme":"bearer","type":"http","scopes":[],"schemeName":"serviceIdentityBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Organization Service Identity API key or M2M access token, sent as `Authorization: Bearer \u003ccredential>`. Restricted to its organization and explicitly granted business permissions. It does not authorize human organization governance or Photon credential management. Never send an M2M client secret to a business endpoint.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"serviceIdentityBearer","name":"Authorization"}],"title":"serviceIdentityBearer"},{"schemes":[{"scheme":{"description":"OAuth grant issued by the Photon authorization server. The token is a bearer JWT whose consented scope is intersected with the permissions the route grants; an empty intersection is `403 insufficient_scope`.","flows":{"authorizationCode":{"authorizationUrl":"https://auth.photon.codes/oauth2/authorize","scopes":{"account:create_project":"Create a project owned by the account.","account:read":"View account profile.","account:read_projects":"List projects associated with the account; does not grant access to project contents.","account:write":"Update account name and profile.","billing:read":"View invoices, usage, payment status.","calls:read":"Read project call data and lifecycle events via supported APIs or approved subscriptions; excludes stored Events queries.","events:read":"Query stored Events and discover their SQL schema within a project.","messages:read":"Read project messages, delivery status, participant changes and typing activity via supported APIs or approved subscriptions.","organization:create_project":"Create a project in the organization.","organization:read":"View organization name and avatar.","organization:read_projects":"List projects in the organization.","platforms:read":"View project platform configuration.","platforms:write":"Change project platform configuration.","project:delete":"Permanently delete the project.","project:read":"View non-sensitive project settings.","project:read_usage":"View project usage and costs.","project:write":"Change agent profiles, webhook settings, and other project configuration.","ten_dlc:read":"View organization 10DLC Brand and Campaign registration records.","ten_dlc:write":"Register and update organization 10DLC Brands and Campaigns, including OTP operations."},"tokenUrl":"https://auth.photon.codes/oauth2/token"}},"type":"oauth2","scopes":["ten_dlc:write"],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"OAuth grant issued by the Photon authorization server. The token is a bearer JWT whose consented scope is intersected with the permissions the route grants; an empty intersection is `403 insufficient_scope`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"}]},"originalFileLocation":"https://api.photon.codes/openapi.json"},"subdomain":"photon-6d78d87b","siteName":"Photon","title":"Verify sole-proprietor OTP - Photon","navMaps":{"firstHrefInVersion":{"Stable":{"href":"/spectrum-ts/introduction","matchLevel":4},"Beta":{"href":"/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-11-05T14:04:49.456Z","originalFileLocation":"beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp.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=\"system\"}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=\"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Photon\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_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=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Verify sole-proprietor OTP - Photon\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Photon\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://photon.codes/docs/images/social-cover.png\">\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=\"Verify sole-proprietor OTP - Photon\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://photon.codes/docs/images/social-cover.png\">\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=\"/docs/mintlify-assets/_mintlify/favicons/photon-6d78d87b/HRqZH79kgfZw4ONr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Photon\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#47c6ed\">\u003cmeta data-mint-head name=\"og:image:alt\" content=\"Photon dashboard on a blue background\">\u003cmeta data-mint-head name=\"twitter:image:alt\" content=\"Photon dashboard on a blue background\">\u003clink data-mint-head rel=\"canonical\" href=\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://photon.codes/#organization\",\"name\":\"Photon\",\"url\":\"https://photon.codes\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/photon-6d78d87b/hMh2hcolREhyGomA/logo/light.svg?fit=max\u0026auto=format\u0026n=hMh2hcolREhyGomA\u0026q=85\u0026s=11512a078b26743f3341822f7095a71d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://photon.codes/docs#website\",\"name\":\"Photon\",\"url\":\"https://photon.codes/docs\",\"publisher\":{\"@id\":\"https://photon.codes/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp#webpage\",\"url\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp\",\"name\":\"Verify sole-proprietor OTP\",\"description\":\"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.\",\"dateModified\":\"2026-11-05T14:04:49.456Z\",\"isPartOf\":{\"@id\":\"https://photon.codes/docs#website\"},\"breadcrumb\":{\"@id\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://photon.codes/docs/beta/api-reference/account/get-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"10DLC brand OTP\",\"item\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/get-sole-proprietor-otp-status\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Verify sole-proprietor OTP\",\"item\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp#apireference\",\"headline\":\"Verify sole-proprietor OTP\",\"name\":\"Verify sole-proprietor OTP\",\"description\":\"Submits otpPin for the selected organization-owned sole-proprietor brand and returns its updated, redacted verification state. A rejected code, a locked verification flow, or rate limiting is reported as an error; read the current OTP status before deciding whether to request another code. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.\",\"url\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp\",\"mainEntityOfPage\":{\"@id\":\"https://photon.codes/docs/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp#webpage\"},\"image\":\"https://photon.codes/docs/images/social-cover.png\",\"dateModified\":\"2026-11-05T14:04:49.456Z\",\"publisher\":{\"@id\":\"https://photon.codes/#organization\"},\"isPartOf\":{\"@id\":\"https://photon.codes/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Photon\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Photon","nav":{"global":null,"versions":[{"version":"Stable","default":true,"pages":[{"title":"Stable","href":"/spectrum-ts/introduction"}]},{"version":"Beta","tag":"Preview","tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/beta/photon"}]},{"tab":"Messaging","pages":[{"title":"Messaging","href":"/beta/messaging"}]},{"tab":"Cookbooks","pages":[{"title":"Cookbooks","href":"/beta/cookbooks"}]},{"tab":"API Client","pages":[{"title":"API Client","href":"/beta/api-client"}]},{"tab":"API Reference","pages":[{"group":"Get started","pages":[{"title":"API reference","href":"/beta/api-reference"}]},{"group":"Problems","pages":[{"title":"Handling errors","href":"/beta/problems/handling-errors"},{"title":"Catalog","mode":"wide","href":"/beta/problems/catalog"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Get account","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/account","href":"/beta/api-reference/account/get-account"},{"title":"Delete account","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/account","href":"/beta/api-reference/account/delete-account"},{"title":"Update account","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/account","href":"/beta/api-reference/account/update-account"},{"title":"Commit profile picture","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/account/profile-picture","href":"/beta/api-reference/account/commit-profile-picture"},{"title":"Remove profile picture","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/account/profile-picture","href":"/beta/api-reference/account/remove-profile-picture"},{"title":"Create profile picture upload","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/account/profile-picture/uploads","href":"/beta/api-reference/account/create-profile-picture-upload"}]},{"group":"Connected Applications","pages":[{"title":"List connected applications","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/account/oauth/authorized-applications","href":"/beta/api-reference/connected-applications/list-connected-applications"},{"title":"Revoke connected application","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/account/oauth/authorized-applications/{applicationId}","href":"/beta/api-reference/connected-applications/revoke-connected-application"}]},{"group":"Account MFA","pages":[{"title":"Get MFA status","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/account/security/mfa","href":"/beta/api-reference/account-mfa/get-mfa-status"},{"title":"Begin TOTP enrollment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/account/security/mfa/totp","href":"/beta/api-reference/account-mfa/begin-totp-enrollment"},{"title":"Verify TOTP enrollment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/account/security/mfa/totp/verify","href":"/beta/api-reference/account-mfa/verify-totp-enrollment"},{"title":"Delete a TOTP factor","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/account/security/mfa/totp/{factorId}","href":"/beta/api-reference/account-mfa/delete-a-totp-factor"}]},{"group":"Account Service Keys","pages":[{"title":"List Account Service Keys","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/account/service-keys","href":"/beta/api-reference/account-service-keys/list-account-service-keys"},{"title":"Create Account Service Key","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/account/service-keys","href":"/beta/api-reference/account-service-keys/create-account-service-key"},{"title":"Revoke Account Service Key","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/account/service-keys/{serviceKeyId}","href":"/beta/api-reference/account-service-keys/revoke-account-service-key"}]},{"group":"Device Authorization","pages":[{"title":"Start device authorization","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/device/code","href":"/beta/api-reference/device-authorization/start-device-authorization"},{"title":"Exchange device code or refresh token","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/device/token","href":"/beta/api-reference/device-authorization/exchange-device-code-or-refresh-token"}]},{"group":"Authentication","pages":[{"title":"Start Login Flow","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/auth/login","href":"/beta/api-reference/authentication/start-login-flow"},{"title":"Start company sign-in","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/login/enrollment","href":"/beta/api-reference/authentication/start-company-sign-in"},{"title":"End Session","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/auth/logout","href":"/beta/api-reference/authentication/end-session"}]},{"group":"OAuth Discovery","pages":[{"title":"List OAuth scopes","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/auth/oauth/scopes","href":"/beta/api-reference/oauth-discovery/list-oauth-scopes"}]},{"group":"Organization Connections","pages":[{"title":"Get organization connection status","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/auth/organizations/{orgId}/connection-status","href":"/beta/api-reference/organization-connections/get-organization-connection-status"},{"title":"Retry organization connection sync","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/connection-sync/retry","href":"/beta/api-reference/organization-connections/retry-organization-connection-sync"}]},{"group":"Organization SSO","pages":[{"title":"Get organization SSO configuration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/auth/organizations/{orgId}/sso","href":"/beta/api-reference/organization-sso/get-organization-sso-configuration"},{"title":"Update organization SSO policy","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/auth/organizations/{orgId}/sso","href":"/beta/api-reference/organization-sso/update-organization-sso-policy"},{"title":"Begin organization SSO admission","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/sso/admission","href":"/beta/api-reference/organization-sso/begin-organization-sso-admission"},{"title":"Sign in with organization SSO","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/sso/authenticate","href":"/beta/api-reference/organization-sso/sign-in-with-organization-sso"},{"title":"Sign in to close organization","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/sso/closure-authenticate","href":"/beta/api-reference/organization-sso/sign-in-to-close-organization"},{"title":"Disable organization SSO","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/sso/disable","href":"/beta/api-reference/organization-sso/disable-organization-sso"},{"title":"Sign in with invitation SSO","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/sso/invitation","href":"/beta/api-reference/organization-sso/sign-in-with-invitation-sso"},{"title":"Create organization setup portal link","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/sso/portal","href":"/beta/api-reference/organization-sso/create-organization-setup-portal-link"},{"title":"Refresh organization SSO connection","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/auth/organizations/{orgId}/sso/refresh","href":"/beta/api-reference/organization-sso/refresh-organization-sso-connection"}]},{"group":"Service","pages":[{"title":"Service Status","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/auth/status","href":"/beta/api-reference/service/service-status"}]},{"group":"App Installations","pages":[{"title":"Request app installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/installation-requests","href":"/beta/api-reference/app-installations/request-app-installation"},{"title":"Redeem installation credential","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/installation-requests/redeem","href":"/beta/api-reference/app-installations/redeem-installation-credential"},{"title":"Return to the app that requested an installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/installation-requests/{requestId}/return","href":"/beta/api-reference/app-installations/return-to-the-app-that-requested-an-installation"},{"title":"Preview an app installation approval","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/installation-requests/{requestId}","href":"/beta/api-reference/app-installations/preview-an-app-installation-approval"},{"title":"List app installations","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/installations","href":"/beta/api-reference/app-installations/list-app-installations"},{"title":"Approve an app installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/installations","href":"/beta/api-reference/app-installations/approve-an-app-installation"},{"title":"Read an app installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/installations/{installationId}","href":"/beta/api-reference/app-installations/read-an-app-installation"},{"title":"Issue the approved installation delivery code","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/installations/{installationId}/code","href":"/beta/api-reference/app-installations/issue-the-approved-installation-delivery-code"},{"title":"Approve installation permissions","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organizationId}/installations/{installationId}/permissions","href":"/beta/api-reference/app-installations/approve-installation-permissions"},{"title":"Repair installation credential delivery","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/installations/{installationId}/repair","href":"/beta/api-reference/app-installations/repair-installation-credential-delivery"},{"title":"Resume an app installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/installations/{installationId}/resume","href":"/beta/api-reference/app-installations/resume-an-app-installation"},{"title":"Suspend an app installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/installations/{installationId}/suspend","href":"/beta/api-reference/app-installations/suspend-an-app-installation"},{"title":"Uninstall an app installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/installations/{installationId}/uninstall","href":"/beta/api-reference/app-installations/uninstall-an-app-installation"}]},{"group":"App installations","pages":[{"title":"Read the credential's App installation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/installations/current","href":"/beta/api-reference/app-installations/read-the-credentials-app-installation"}]},{"group":"Organizations","pages":[{"title":"List organizations","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations","href":"/beta/api-reference/organizations/list-organizations"},{"title":"Create an organization","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations","href":"/beta/api-reference/organizations/create-an-organization"},{"title":"Read the credential's organization","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/current","href":"/beta/api-reference/organizations/read-the-credentials-organization"},{"title":"Read organization name and avatar","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}","href":"/beta/api-reference/organizations/read-organization-name-and-avatar"},{"title":"Delete organization","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/organizations/{organizationId}","href":"/beta/api-reference/organizations/delete-organization"},{"title":"Change organization name","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organizationId}","href":"/beta/api-reference/organizations/change-organization-name"},{"title":"Remove an organization avatar","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/organizations/{organizationId}/avatar","href":"/beta/api-reference/organizations/remove-an-organization-avatar"},{"title":"Commit an organization avatar","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/avatar/commit","href":"/beta/api-reference/organizations/commit-an-organization-avatar"},{"title":"Create an organization avatar upload","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/avatar/uploads","href":"/beta/api-reference/organizations/create-an-organization-avatar-upload"},{"title":"Check organization deletion prerequisites","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/deletion-check","href":"/beta/api-reference/organizations/check-organization-deletion-prerequisites"},{"title":"Read SSO subscription","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/sso/subscription","href":"/beta/api-reference/organizations/read-sso-subscription"},{"title":"Subscribe to organization SSO","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/sso/subscription","href":"/beta/api-reference/organizations/subscribe-to-organization-sso"},{"title":"Cancel the SSO subscription","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/sso/subscription/cancel","href":"/beta/api-reference/organizations/cancel-the-sso-subscription"}]},{"group":"Organization Invitations","pages":[{"title":"Accept an invitation to all organization projects","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/invitations/accept","href":"/beta/api-reference/organization-invitations/accept-an-invitation-to-all-organization-projects"},{"title":"Preview an organization invitation after sign-in","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/invitations/preview","href":"/beta/api-reference/organization-invitations/preview-an-organization-invitation-after-sign-in"},{"title":"List pending organization invitations","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/invitations","href":"/beta/api-reference/organization-invitations/list-pending-organization-invitations"},{"title":"Invite a Member or Viewer to all organization projects","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/invitations","href":"/beta/api-reference/organization-invitations/invite-a-member-or-viewer-to-all-organization-projects"},{"title":"Resend an organization invitation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/invitations/{invitationId}/resend","href":"/beta/api-reference/organization-invitations/resend-an-organization-invitation"},{"title":"Revoke an organization invitation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/invitations/{invitationId}/revoke","href":"/beta/api-reference/organization-invitations/revoke-an-organization-invitation"}]},{"group":"App Installation Configurations","pages":[{"title":"List developer apps","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/apps","href":"/beta/api-reference/app-installation-configurations/list-developer-apps"},{"title":"Register a developer app","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/apps","href":"/beta/api-reference/app-installation-configurations/register-a-developer-app"},{"title":"Read developer app configuration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/apps/{appId}","href":"/beta/api-reference/app-installation-configurations/read-developer-app-configuration"},{"title":"Replace developer app configuration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organizationId}/apps/{appId}","href":"/beta/api-reference/app-installation-configurations/replace-developer-app-configuration"},{"title":"Stop new installations of a developer app","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/apps/{appId}/disable","href":"/beta/api-reference/app-installation-configurations/stop-new-installations-of-a-developer-app"},{"title":"Accept new installations of a developer app again","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/apps/{appId}/enable","href":"/beta/api-reference/app-installation-configurations/accept-new-installations-of-a-developer-app-again"},{"title":"Retire a developer app permanently","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/apps/{appId}/retire","href":"/beta/api-reference/app-installation-configurations/retire-a-developer-app-permanently"},{"title":"Read an App webhook signing key status","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/apps/{appId}/webhook-signing-key","href":"/beta/api-reference/app-installation-configurations/read-an-app-webhook-signing-key-status"},{"title":"Reveal an App webhook signing secret once","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/apps/{appId}/webhook-signing-key/reveal","href":"/beta/api-reference/app-installation-configurations/reveal-an-app-webhook-signing-secret-once"}]},{"group":"Organization Billing","pages":[{"title":"Get organization billing overview","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing","href":"/beta/api-reference/organization-billing/get-organization-billing-overview"},{"title":"Create payment method checkout","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/billing/checkout","href":"/beta/api-reference/organization-billing/create-payment-method-checkout"},{"title":"Get organization credit","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing/credit","href":"/beta/api-reference/organization-billing/get-organization-credit"},{"title":"List credit activity","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing/credit/activity","href":"/beta/api-reference/organization-billing/list-credit-activity"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing/invoices","href":"/beta/api-reference/organization-billing/list-invoices"},{"title":"List payments to confirm","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing/payment-actions","href":"/beta/api-reference/organization-billing/list-payments-to-confirm"},{"title":"Get organization payment method","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing/payment-method","href":"/beta/api-reference/organization-billing/get-organization-payment-method"},{"title":"Preview an organization billing change","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/billing/preview","href":"/beta/api-reference/organization-billing/preview-an-organization-billing-change"},{"title":"Preview a project billing change","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/billing/projects/{projectId}/preview","href":"/beta/api-reference/organization-billing/preview-a-project-billing-change"},{"title":"Get the project's effective billing terms","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing/projects/{projectId}/terms","href":"/beta/api-reference/organization-billing/get-the-projects-effective-billing-terms"},{"title":"Get the organization's effective billing terms","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/billing/terms","href":"/beta/api-reference/organization-billing/get-the-organizations-effective-billing-terms"}]},{"group":"Project Billing","pages":[{"title":"Change plan","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/billing/projects/{projectId}/purchase","href":"/beta/api-reference/project-billing/change-plan"},{"title":"Get project billing overview","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/billing","href":"/beta/api-reference/project-billing/get-project-billing-overview"},{"title":"Get billing operation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/billing/operations/{operationId}","href":"/beta/api-reference/project-billing/get-billing-operation"},{"title":"List billing plans","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/billing/plans","href":"/beta/api-reference/project-billing/list-billing-plans"},{"title":"List project subscriptions","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/billing/subscriptions","href":"/beta/api-reference/project-billing/list-project-subscriptions"}]},{"group":"Organization Members","pages":[{"title":"Leave an organization; Owners must transfer or close first","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/leave","href":"/beta/api-reference/organization-members/leave-an-organization;-owners-must-transfer-or-close-first"},{"title":"List current organization members","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/members","href":"/beta/api-reference/organization-members/list-current-organization-members"},{"title":"Remove a member from the organization","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/organizations/{organizationId}/members/{memberAccountId}","href":"/beta/api-reference/organization-members/remove-a-member-from-the-organization"},{"title":"Change an organization member's role across all projects","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organizationId}/members/{memberAccountId}","href":"/beta/api-reference/organization-members/change-an-organization-members-role-across-all-projects"},{"title":"Transfer organization ownership to an existing member","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/transfer-ownership","href":"/beta/api-reference/organization-members/transfer-organization-ownership-to-an-existing-member"}]},{"group":"Organization OAuth","pages":[{"title":"List organization OAuth clients","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/oauth/clients","href":"/beta/api-reference/organization-oauth/list-organization-oauth-clients"},{"title":"Create an organization OAuth client","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/oauth/clients","href":"/beta/api-reference/organization-oauth/create-an-organization-oauth-client"},{"title":"Read an organization OAuth client","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/oauth/clients/{clientId}","href":"/beta/api-reference/organization-oauth/read-an-organization-oauth-client"},{"title":"Delete an organization OAuth client","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/organizations/{organizationId}/oauth/clients/{clientId}","href":"/beta/api-reference/organization-oauth/delete-an-organization-oauth-client"},{"title":"Update an organization OAuth client","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organizationId}/oauth/clients/{clientId}","href":"/beta/api-reference/organization-oauth/update-an-organization-oauth-client"},{"title":"Read an organization OAuth client's secret","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/oauth/clients/{clientId}/secret","href":"/beta/api-reference/organization-oauth/read-an-organization-oauth-clients-secret"},{"title":"Create an organization OAuth client's secret","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/organizations/{organizationId}/oauth/clients/{clientId}/secret","href":"/beta/api-reference/organization-oauth/create-an-organization-oauth-clients-secret"},{"title":"Revoke an organization OAuth client's secret","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/organizations/{organizationId}/oauth/clients/{clientId}/secret","href":"/beta/api-reference/organization-oauth/revoke-an-organization-oauth-clients-secret"},{"title":"Rotate an organization OAuth client's secret","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/oauth/clients/{clientId}/secret/rotate","href":"/beta/api-reference/organization-oauth/rotate-an-organization-oauth-clients-secret"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/projects","href":"/beta/api-reference/projects/list-projects"},{"title":"Create project","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/projects","href":"/beta/api-reference/projects/create-project"},{"title":"Get project closure status","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/projects/closure-status","href":"/beta/api-reference/projects/get-project-closure-status"},{"title":"Count projects","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/projects/count","href":"/beta/api-reference/projects/count-projects"},{"title":"Check project slug availability","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/projects/slug-availability","href":"/beta/api-reference/projects/check-project-slug-availability"},{"title":"Get project","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}","href":"/beta/api-reference/projects/get-project"},{"title":"Delete project","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{projectId}","href":"/beta/api-reference/projects/delete-project"},{"title":"Update project","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{projectId}","href":"/beta/api-reference/projects/update-project"}]},{"group":"Service Identities","pages":[{"title":"List organization Service Identities","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/service-identities","href":"/beta/api-reference/service-identities/list-organization-service-identities"},{"title":"Create an organization Service Identity","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/service-identities","href":"/beta/api-reference/service-identities/create-an-organization-service-identity"},{"title":"List grantable Service Identity permissions","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/service-identities/permissions","href":"/beta/api-reference/service-identities/list-grantable-service-identity-permissions"},{"title":"Read a Service Identity","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/service-identities/{serviceIdentityId}","href":"/beta/api-reference/service-identities/read-a-service-identity"},{"title":"Update a Service Identity","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organizationId}/service-identities/{serviceIdentityId}","href":"/beta/api-reference/service-identities/update-a-service-identity"},{"title":"Read Service Identity M2M configuration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/service-identities/{serviceIdentityId}/m2m","href":"/beta/api-reference/service-identities/read-service-identity-m2m-configuration"}]},{"group":"Service Credentials","pages":[{"title":"List Service Identity credential metadata","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organizationId}/service-identities/{serviceIdentityId}/credentials","href":"/beta/api-reference/service-credentials/list-service-identity-credential-metadata"},{"title":"Create a one-time Service Identity API key","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/service-identities/{serviceIdentityId}/credentials/api-keys","href":"/beta/api-reference/service-credentials/create-a-one-time-service-identity-api-key"},{"title":"Create a one-time Service Identity M2M client secret","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/service-identities/{serviceIdentityId}/credentials/client-secrets","href":"/beta/api-reference/service-credentials/create-a-one-time-service-identity-m2m-client-secret"},{"title":"Request Service Identity credential revocation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organizationId}/service-identities/{serviceIdentityId}/credentials/{credentialId}/revoke","href":"/beta/api-reference/service-credentials/request-service-identity-credential-revocation"}]},{"group":"10DLC brands","pages":[{"title":"List brands","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/brands","href":"/beta/api-reference/10dlc-brands/list-brands"},{"title":"Register a brand","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organization_id}/10dlc/brands","href":"/beta/api-reference/10dlc-brands/register-a-brand"},{"title":"Get a redacted brand","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/brands/{brandId}","href":"/beta/api-reference/10dlc-brands/get-a-redacted-brand"},{"title":"Delete an unverified brand registration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/organizations/{organization_id}/10dlc/brands/{brandId}","href":"/beta/api-reference/10dlc-brands/delete-an-unverified-brand-registration"},{"title":"Correct a brand","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organization_id}/10dlc/brands/{brandId}","href":"/beta/api-reference/10dlc-brands/correct-a-brand"}]},{"group":"10DLC campaigns","pages":[{"title":"Register a campaign","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organization_id}/10dlc/brands/{brandId}/campaigns","href":"/beta/api-reference/10dlc-campaigns/register-a-campaign"},{"title":"List campaign use cases","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/campaign-use-cases","href":"/beta/api-reference/10dlc-campaigns/list-campaign-use-cases"},{"title":"List campaigns","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/campaigns","href":"/beta/api-reference/10dlc-campaigns/list-campaigns"},{"title":"Get a campaign","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}","href":"/beta/api-reference/10dlc-campaigns/get-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}","href":"/beta/api-reference/10dlc-campaigns/update-a-campaign"},{"title":"Resubmit a rejected campaign","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}/resubmit","href":"/beta/api-reference/10dlc-campaigns/resubmit-a-rejected-campaign"},{"title":"List campaign review history","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/campaigns/{campaignId}/review-history","href":"/beta/api-reference/10dlc-campaigns/list-campaign-review-history"},{"title":"Get campaign fees","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/fees","href":"/beta/api-reference/10dlc-campaigns/get-campaign-fees"}]},{"group":"10DLC brand OTP","pages":[{"title":"Get sole-proprietor OTP status","description":"Returns the redacted one-time-password verification state for an organization-owned brand. OTP verification applies only to sole-proprietor brands. Reading this endpoint does not request another code or verify a supplied code; use the trigger and verification operations for those actions. Supply organization_id for the organization that owns the registration.","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/organizations/{organization_id}/10dlc/brands/{brandId}/otp","href":"/beta/api-reference/10dlc-brand-otp/get-sole-proprietor-otp-status"},{"title":"Verify sole-proprietor OTP","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/organizations/{organization_id}/10dlc/brands/{brandId}/otp","href":"/beta/api-reference/10dlc-brand-otp/verify-sole-proprietor-otp"},{"title":"Trigger sole-proprietor OTP","description":"Requests delivery of a verification code for an organization-owned sole-proprietor brand. A 202 response acknowledges the delivery request and does not mean the brand has been verified. Inspect the OTP status and submit the received code through verifyTenDlcBrandOtp. Requests may be rate limited. Supply the required Idempotency-Key header. Supply organization_id for the organization that owns the registration.","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/organizations/{organization_id}/10dlc/brands/{brandId}/otp","href":"/beta/api-reference/10dlc-brand-otp/trigger-sole-proprietor-otp"}]},{"group":"Attachments","pages":[{"title":"List attachments","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/attachments","href":"/beta/api-reference/attachments/list-attachments"},{"title":"Upload attachment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/attachments","href":"/beta/api-reference/attachments/upload-attachment"},{"title":"Get attachment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/attachments/{attachmentId}","href":"/beta/api-reference/attachments/get-attachment"},{"title":"Download attachment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/attachments/{attachmentId}/content","href":"/beta/api-reference/attachments/download-attachment"}]},{"group":"Messages","pages":[{"title":"List Messages","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/messages","href":"/beta/api-reference/messages/list-messages"},{"title":"Send a Message","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/messages","href":"/beta/api-reference/messages/send-a-message"},{"title":"Count Messages","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/messages/count","href":"/beta/api-reference/messages/count-messages"},{"title":"Get a Message","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/messages/{messageId}","href":"/beta/api-reference/messages/get-a-message"},{"title":"Mark a Message as read","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/messages/{messageId}/read","href":"/beta/api-reference/messages/mark-a-message-as-read"}]},{"group":"Platforms","pages":[{"title":"List project platforms","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms","href":"/beta/api-reference/platforms/list-project-platforms"},{"title":"Get project iMessage platform","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/imessage","href":"/beta/api-reference/platforms/get-project-imessage-platform"},{"title":"Get project WhatsApp platform","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/whatsapp","href":"/beta/api-reference/platforms/get-project-whatsapp-platform"}]},{"group":"Email domains","pages":[{"title":"Connect email domain","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/email/domains","href":"/beta/api-reference/email-domains/connect-email-domain"}]},{"group":"Email","pages":[{"title":"Get email delivery metrics","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/email/metrics","href":"/beta/api-reference/email/get-email-delivery-metrics"},{"title":"List email recommendations","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/email/recommendations","href":"/beta/api-reference/email/list-email-recommendations"},{"title":"Get email sending policies","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/email/sending-policy","href":"/beta/api-reference/email/get-email-sending-policies"}]},{"group":"Verification codes","pages":[{"title":"List filtered verification codes","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/filtered-otp","href":"/beta/api-reference/verification-codes/list-filtered-verification-codes"},{"title":"Count filtered verification codes","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/filtered-otp/count","href":"/beta/api-reference/verification-codes/count-filtered-verification-codes"},{"title":"List a line's filtered verification codes","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/resources/{resourceId}/filtered-otp","href":"/beta/api-reference/verification-codes/list-a-lines-filtered-verification-codes"},{"title":"Count a line's filtered verification codes","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/resources/{resourceId}/filtered-otp/count","href":"/beta/api-reference/verification-codes/count-a-lines-filtered-verification-codes"}]},{"group":"Shared line assignments","pages":[{"title":"List shared line assignments","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/imessage/assignments","href":"/beta/api-reference/shared-line-assignments/list-shared-line-assignments"},{"title":"Create shared line assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/imessage/assignments","href":"/beta/api-reference/shared-line-assignments/create-shared-line-assignment"},{"title":"Get shared line assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/imessage/assignments/{assignmentId}","href":"/beta/api-reference/shared-line-assignments/get-shared-line-assignment"},{"title":"Release shared line assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/imessage/assignments/{assignmentId}","href":"/beta/api-reference/shared-line-assignments/release-shared-line-assignment"}]},{"group":"Dedicated iMessage lines","pages":[{"title":"Provision dedicated iMessage line","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/imessage/dedicated","href":"/beta/api-reference/dedicated-imessage-lines/provision-dedicated-imessage-line"},{"title":"Release dedicated iMessage line","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/imessage/dedicated/{resourceId}","href":"/beta/api-reference/dedicated-imessage-lines/release-dedicated-imessage-line"}]},{"group":"Operations","pages":[{"title":"List operations","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/operations","href":"/beta/api-reference/operations/list-operations"},{"title":"Get operation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/operations/{operationId}","href":"/beta/api-reference/operations/get-operation"},{"title":"Cancel operation","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/operations/{operationId}/cancel","href":"/beta/api-reference/operations/cancel-operation"}]},{"group":"Resources","pages":[{"title":"List resources","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/resources","href":"/beta/api-reference/resources/list-resources"},{"title":"Get resource","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/resources/{resourceId}","href":"/beta/api-reference/resources/get-resource"},{"title":"Release resource","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/resources/{resourceId}","href":"/beta/api-reference/resources/release-resource"}]},{"group":"SMS campaigns","pages":[{"title":"Get SMS line campaign assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/sms/lines/{resourceId}/campaign","href":"/beta/api-reference/sms-campaigns/get-sms-line-campaign-assignment"},{"title":"Assign or replace SMS line campaign","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/projects/{id}/platforms/sms/lines/{resourceId}/campaign","href":"/beta/api-reference/sms-campaigns/assign-or-replace-sms-line-campaign"},{"title":"Unassign SMS line campaign","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/sms/lines/{resourceId}/campaign","href":"/beta/api-reference/sms-campaigns/unassign-sms-line-campaign"}]},{"group":"SMS numbers","pages":[{"title":"Purchase SMS number","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/sms/numbers","href":"/beta/api-reference/sms-numbers/purchase-sms-number"},{"title":"List number area codes","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/sms/numbers/area-codes","href":"/beta/api-reference/sms-numbers/list-number-area-codes"},{"title":"List number countries","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/sms/numbers/countries","href":"/beta/api-reference/sms-numbers/list-number-countries"}]},{"group":"Telegram","pages":[{"title":"Connect Telegram bot","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/telegram/bots","href":"/beta/api-reference/telegram/connect-telegram-bot"}]},{"group":"Voice","pages":[{"title":"Batch update Voice line assignments","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/voice/lines/profile-assignments/batch","href":"/beta/api-reference/voice/batch-update-voice-line-assignments"},{"title":"Get Voice line profile assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/voice/lines/{resourceId}/profile","href":"/beta/api-reference/voice/get-voice-line-profile-assignment"},{"title":"Assign Voice line profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/projects/{id}/platforms/voice/lines/{resourceId}/profile","href":"/beta/api-reference/voice/assign-voice-line-profile"},{"title":"Unassign Voice line profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/voice/lines/{resourceId}/profile","href":"/beta/api-reference/voice/unassign-voice-line-profile"},{"title":"List Voice profiles","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/voice/profiles","href":"/beta/api-reference/voice/list-voice-profiles"},{"title":"Create Voice profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/voice/profiles","href":"/beta/api-reference/voice/create-voice-profile"},{"title":"Get default Voice profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/voice/profiles/default","href":"/beta/api-reference/voice/get-default-voice-profile"},{"title":"Create default Voice profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/projects/{id}/platforms/voice/profiles/default","href":"/beta/api-reference/voice/create-default-voice-profile"},{"title":"Update default Voice profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{id}/platforms/voice/profiles/default","href":"/beta/api-reference/voice/update-default-voice-profile"},{"title":"Get Voice profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/voice/profiles/{profileId}","href":"/beta/api-reference/voice/get-voice-profile"},{"title":"Delete Voice profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/voice/profiles/{profileId}","href":"/beta/api-reference/voice/delete-voice-profile"},{"title":"Update Voice profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{id}/platforms/voice/profiles/{profileId}","href":"/beta/api-reference/voice/update-voice-profile"},{"title":"Replace Voice inbound configuration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound","href":"/beta/api-reference/voice/replace-voice-inbound-configuration"},{"title":"Delete Voice inbound configuration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound","href":"/beta/api-reference/voice/delete-voice-inbound-configuration"},{"title":"Update Voice inbound configuration","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{id}/platforms/voice/profiles/{profileId}/inbound","href":"/beta/api-reference/voice/update-voice-inbound-configuration"},{"title":"Configure Voice outbound credential","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/projects/{id}/platforms/voice/profiles/{profileId}/outbound","href":"/beta/api-reference/voice/configure-voice-outbound-credential"},{"title":"Revoke Voice outbound credential","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/voice/profiles/{profileId}/outbound","href":"/beta/api-reference/voice/revoke-voice-outbound-credential"},{"title":"Update Voice outbound authentication","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{id}/platforms/voice/profiles/{profileId}/outbound","href":"/beta/api-reference/voice/update-voice-outbound-authentication"},{"title":"Rotate Voice outbound credential","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/voice/profiles/{profileId}/outbound/rotate","href":"/beta/api-reference/voice/rotate-voice-outbound-credential"}]},{"group":"WhatsApp Business","pages":[{"title":"Get WhatsApp Business account","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/whatsapp-business/account","href":"/beta/api-reference/whatsapp-business/get-whatsapp-business-account"},{"title":"Disconnect WhatsApp Business account","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/whatsapp-business/account","href":"/beta/api-reference/whatsapp-business/disconnect-whatsapp-business-account"},{"title":"List WhatsApp account phone numbers","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/whatsapp-business/account/phone-numbers","href":"/beta/api-reference/whatsapp-business/list-whatsapp-account-phone-numbers"},{"title":"Create WhatsApp VoIP sender","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/whatsapp-business/account/senders","href":"/beta/api-reference/whatsapp-business/create-whatsapp-voip-sender"},{"title":"Connect WhatsApp Business","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/whatsapp-business/numbers","href":"/beta/api-reference/whatsapp-business/connect-whatsapp-business"},{"title":"Get WhatsApp Business verification code","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/whatsapp-business/numbers/{resourceId}/verification-code","href":"/beta/api-reference/whatsapp-business/get-whatsapp-business-verification-code"},{"title":"Get WhatsApp signup config","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/whatsapp-business/signup-config","href":"/beta/api-reference/whatsapp-business/get-whatsapp-signup-config"}]},{"group":"WhatsApp shared line assignments","pages":[{"title":"List WhatsApp shared line assignments","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/whatsapp/assignments","href":"/beta/api-reference/whatsapp-shared-line-assignments/list-whatsapp-shared-line-assignments"},{"title":"Create WhatsApp shared line assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/whatsapp/assignments","href":"/beta/api-reference/whatsapp-shared-line-assignments/create-whatsapp-shared-line-assignment"},{"title":"Get WhatsApp shared line assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/platforms/whatsapp/assignments/{assignmentId}","href":"/beta/api-reference/whatsapp-shared-line-assignments/get-whatsapp-shared-line-assignment"},{"title":"Release WhatsApp shared line assignment","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/whatsapp/assignments/{assignmentId}","href":"/beta/api-reference/whatsapp-shared-line-assignments/release-whatsapp-shared-line-assignment"}]},{"group":"Dedicated WhatsApp lines","pages":[{"title":"Provision dedicated WhatsApp line","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/platforms/whatsapp/dedicated","href":"/beta/api-reference/dedicated-whatsapp-lines/provision-dedicated-whatsapp-line"},{"title":"Release dedicated WhatsApp line","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{id}/platforms/whatsapp/dedicated/{resourceId}","href":"/beta/api-reference/dedicated-whatsapp-lines/release-dedicated-whatsapp-line"}]},{"group":"Spaces","pages":[{"title":"List Spaces","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/spaces","href":"/beta/api-reference/spaces/list-spaces"},{"title":"Create or get a Space","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/spaces","href":"/beta/api-reference/spaces/create-or-get-a-space"},{"title":"Count Spaces","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/spaces/count","href":"/beta/api-reference/spaces/count-spaces"},{"title":"Get a Space","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/spaces/{spaceId}","href":"/beta/api-reference/spaces/get-a-space"},{"title":"Set typing in a Space","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/spaces/{spaceId}/typing","href":"/beta/api-reference/spaces/set-typing-in-a-space"}]},{"group":"Users","pages":[{"title":"List Users","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/users","href":"/beta/api-reference/users/list-users"},{"title":"Create or get a User","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{id}/users","href":"/beta/api-reference/users/create-or-get-a-user"},{"title":"Count Users","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/users/count","href":"/beta/api-reference/users/count-users"},{"title":"Get an User","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{id}/users/{userId}","href":"/beta/api-reference/users/get-an-user"}]},{"group":"Agent Profile","pages":[{"title":"Get agent profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/agent-profile","href":"/beta/api-reference/agent-profile/get-agent-profile"},{"title":"Update agent profile","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{projectId}/agent-profile","href":"/beta/api-reference/agent-profile/update-agent-profile"},{"title":"Commit agent avatar","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json put /v1/projects/{projectId}/agent-profile/avatar","href":"/beta/api-reference/agent-profile/commit-agent-avatar"},{"title":"Reset agent avatar","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{projectId}/agent-profile/avatar","href":"/beta/api-reference/agent-profile/reset-agent-avatar"},{"title":"Create agent avatar upload","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{projectId}/agent-profile/avatar/uploads","href":"/beta/api-reference/agent-profile/create-agent-avatar-upload"}]},{"group":"API keys","pages":[{"title":"List project API keys","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/api-keys","href":"/beta/api-reference/api-keys/list-project-api-keys"},{"title":"Create project API key","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{projectId}/api-keys","href":"/beta/api-reference/api-keys/create-project-api-key"},{"title":"Revoke project API key","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{projectId}/api-keys/{apiKeyId}","href":"/beta/api-reference/api-keys/revoke-project-api-key"},{"title":"Update project API key permissions","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{projectId}/api-keys/{apiKeyId}","href":"/beta/api-reference/api-keys/update-project-api-key-permissions"}]},{"group":"Developer OTel","pages":[{"title":"List Developer OTel log records","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/developer/otel/logs","href":"/beta/api-reference/developer-otel/list-developer-otel-log-records"},{"title":"Get the Developer OTel query schema","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/developer/otel/query","href":"/beta/api-reference/developer-otel/get-the-developer-otel-query-schema"},{"title":"Query Developer OTel data","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{projectId}/developer/otel/query","href":"/beta/api-reference/developer-otel/query-developer-otel-data"},{"title":"List Developer traces","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/developer/otel/traces","href":"/beta/api-reference/developer-otel/list-developer-traces"},{"title":"Get a Developer trace","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/developer/otel/traces/{traceId}","href":"/beta/api-reference/developer-otel/get-a-developer-trace"}]},{"group":"Messaging \u0026 Voice Metrics","pages":[{"title":"Get metrics backfill status","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/metrics/backfill","href":"/beta/api-reference/messaging-\u0026-voice-metrics/get-metrics-backfill-status"},{"title":"Get metrics SQL schema","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/metrics/query","href":"/beta/api-reference/messaging-\u0026-voice-metrics/get-metrics-sql-schema"},{"title":"Query metrics","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{projectId}/metrics/query","href":"/beta/api-reference/messaging-\u0026-voice-metrics/query-metrics"}]},{"group":"Webhook Event Catalog","pages":[{"title":"List webhook API versions","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/webhooks/api-versions","href":"/beta/api-reference/webhook-event-catalog/list-webhook-api-versions"},{"title":"List webhook event types","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/webhooks/event-types","href":"/beta/api-reference/webhook-event-catalog/list-webhook-event-types"},{"title":"Get webhook event schema","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/webhooks/event-types/{eventType}/schema","href":"/beta/api-reference/webhook-event-catalog/get-webhook-event-schema"}]},{"group":"Webhook Destinations","pages":[{"title":"List webhook destinations","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/webhooks/destinations","href":"/beta/api-reference/webhook-destinations/list-webhook-destinations"},{"title":"Create webhook destination","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{projectId}/webhooks/destinations","href":"/beta/api-reference/webhook-destinations/create-webhook-destination"},{"title":"Get webhook destination","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/webhooks/destinations/{destinationId}","href":"/beta/api-reference/webhook-destinations/get-webhook-destination"},{"title":"Delete webhook destination","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json delete /v1/projects/{projectId}/webhooks/destinations/{destinationId}","href":"/beta/api-reference/webhook-destinations/delete-webhook-destination"},{"title":"Update webhook destination","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json patch /v1/projects/{projectId}/webhooks/destinations/{destinationId}","href":"/beta/api-reference/webhook-destinations/update-webhook-destination"},{"title":"Rotate webhook signing secret","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{projectId}/webhooks/destinations/{destinationId}/secret-rotations","href":"/beta/api-reference/webhook-destinations/rotate-webhook-signing-secret"}]},{"group":"Webhook Delivery","pages":[{"title":"Retry webhook delivery","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json post /v1/projects/{projectId}/webhooks/destinations/{destinationId}/retries","href":"/beta/api-reference/webhook-delivery/retry-webhook-delivery"},{"title":"List webhook egress addresses","deprecated":null,"version":null,"openapi":"https://api.photon.codes/openapi.json get /v1/projects/{projectId}/webhooks/egress-addresses","href":"/beta/api-reference/webhook-delivery/list-webhook-egress-addresses"}]}]},{"group":"Event Delivery WebSocket","pages":[{"group":"Event Delivery WebSocket","pages":[{"title":"Event delivery over Socket.IO","href":"/beta/websocket/index"},{"title":"Connect","href":"/beta/websocket/connect"},{"title":"Start a session","href":"/beta/websocket/session"},{"title":"Receive events","href":"/beta/websocket/events"},{"title":"Cursors, replay, and checkpointing","href":"/beta/websocket/cursors"},{"title":"Reply to a webhook event","href":"/beta/websocket/replies"},{"title":"Errors and reconnection","href":"/beta/websocket/errors"},{"title":"Client examples","href":"/beta/websocket/example"}]},{"group":"Frame reference","pages":[{"title":"Event reference","asyncapi":"https://api.photon.codes/asyncapi.yaml Root","href":"/beta/websocket/frames"}]}]},{"group":"Event schemas","pages":[{"group":"Websockets","pages":[{"asyncapi":"https://api.photon.codes/asyncapi.yaml Root","href":"/beta/websocket/reference/websockets/event-delivery","title":"Event Delivery","version":null}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/beta/changelog"}]}],"global":{"anchors":[{"anchor":"Blog","icon":"newspaper","href":"https://photon.codes/blog"},{"anchor":"Community","icon":{"style":"brands","name":"discord","library":"fontawesome"},"href":"https://discord.gg/4mr54mqQN"},{"anchor":"Status","icon":{"name":"monitor-waveform","library":"lucide"},"href":"https://status.photon.codes"}]}}]},"basePath":"","title":"Verify sole-proprietor OTP - Photon","buildId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","deploymentId":"dpl_6dVqRXFR2Go5vF5RLvAdHuv189oT","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-D_7my4bd.js","utils-Cq_itTNA.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B5KPEvGz.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DBX-JepP.js","snippetPresets-Bsspz-Ge.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-t8ynOKTD.js","ApiExamples-jcs-2nGf.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dp53in7F.js","shallow-Dv9eUdUd.js","getApiPlaygroundDisplay-D8cDwNhi.js","CodeSnippet-DkwXLQor.js","CodeSnippets-DcSgKqs5.js","getPastedJson-I2RjoApV.js","icon-BIj57rZC.js","MethodPill-CTwLPWXC.js","DuplicateIcon-BJpFwygY.js","createIcon-C7PorfAe.js","DynamicMarkdown-BBht_uEs.js","SectionHeading-YIBwxbzj.js","axios-vUo_bRtp.js","Markdown--YCeFtOs.js","clsx-CrPa459s.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BWxsj3I0.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fBzVvq7k.js"]}