Create or resume hosted verification for the session customer
Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A pending result with nextAction must be presented in an iframe; pending without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.
POST
/
compliance
/
verification
Create or resume hosted verification for the session customer
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Rhinestone","colors":{"primary":"#4f41ef","light":"#8479ff","dark":"#3428d1"},"logo":{"light":"https://mintcdn.com/rhinestone/IVpDy9zUkncYAe5u/logo/light.svg?fit=max\u0026auto=format\u0026n=IVpDy9zUkncYAe5u\u0026q=85\u0026s=6868a5854576ff60d371d5fdc0ae55c9","dark":"https://mintcdn.com/rhinestone/IVpDy9zUkncYAe5u/logo/dark.svg?fit=max\u0026auto=format\u0026n=IVpDy9zUkncYAe5u\u0026q=85\u0026s=2f9bff4fef6da993b8782b8e5d7357c5"},"favicon":"https://mintcdn.com/rhinestone/BVnq0VV8MigHINpS/favicon.svg?fit=max\u0026auto=format\u0026n=BVnq0VV8MigHINpS\u0026q=85\u0026s=25439e41b789b8369c52fa15ceae2644","appearance":{"default":"dark","strict":true},"background":{"color":{"dark":"#0C0C0C"}},"navbar":{"links":[{"href":"https://dashboard.rhinestone.dev","label":"Dashboard"},{"href":"https://github.com/rhinestonewtf","label":"GitHub"}]},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","claude","chatgpt"],"display":"header"},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Create API Key","icon":"key","href":"https://tally.so/r/wg22x4"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"rhinestone","hasAudioNarration":false,"actualSubdomain":"rhinestone","customDomains":["docs.rhinestone.dev"],"gitSource":{"type":"github","owner":"rhinestonewtf","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae8b4376bec035f345a38cf","collectionId":"fef892a2-dfbe-4823-b045-cb291160ec97","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8b4376bec035f345a38cf"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae8b4376bec035f345a38cf","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Wallets","count":153},{"language":"default","tag":"Custom signer","count":107},{"language":"default","tag":"Deposits","count":88},{"language":"default","tag":"SDK reference","count":74},{"language":"default","tag":"API Reference","count":67},{"language":"default","tag":"Transactions","count":30},{"language":"default","tag":"Account","count":28},{"language":"default","tag":"Overview","count":25},{"language":"default","tag":"Actions","count":25},{"language":"default","tag":"Session keys","count":21}]},"assistantConfig":{},"basePath":"","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--background:#0C0C0C}.vm-code-group{--vm-menu-bg:#fff;--vm-menu-border:rgb(0 0 0 / 10%);--vm-hover:rgb(0 0 0 / 5%);margin:1.5rem 0;border:1px solid #404045;border-radius:12px}.dark .vm-code-group{--vm-menu-bg:#171717;--vm-menu-border:rgb(255 255 255 / 10%);--vm-hover:rgb(255 255 255 / 7%)}.vm-code-group-header{display:flex;align-items:center;justify-content:space-between;gap:.75rem;padding:.375rem .75rem;border-bottom:1px solid #404045;font-size:.8125rem}.vm-code-caption{flex:1;min-width:0;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;opacity:.65}.vm-code-selector{position:relative;flex:none}.vm-code-option,.vm-code-trigger{display:flex;align-items:center;gap:.5rem;min-height:32px;padding:.375rem .5rem;border:0;border-radius:6px;background:0 0;color:inherit;font:inherit;line-height:1.25;cursor:pointer}.vm-code-option:focus,.vm-code-option:hover,.vm-code-trigger:hover,.vm-code-trigger[aria-expanded=true]{background:var(--vm-hover)}.vm-code-option:focus-visible,.vm-code-trigger:focus-visible{outline:2px solid #8b7bf7;outline-offset:2px}.vm-code-group .vm-code-icon{display:block;flex:none;width:16px;height:16px;margin:0;border-radius:0}.vm-code-chevron{margin-left:.125rem;opacity:.55;transition:transform 150ms ease}.vm-code-trigger[aria-expanded=true] .vm-code-chevron{transform:rotate(180deg)}.vm-code-menu{position:absolute;top:calc(100% + 6px);right:0;z-index:30;min-width:156px;padding:4px;border:1px solid var(--vm-menu-border);border-radius:10px;background:var(--vm-menu-bg);box-shadow:0 8px 24px rgb(0 0 0/18%)}.vm-code-option{width:100%;text-align:left}.vm-code-check{margin-left:auto;opacity:.65}@media (pointer:coarse){.vm-code-option,.vm-code-trigger{min-height:44px}}@media (prefers-reduced-motion:reduce){.vm-code-chevron{transition:none}}.vm-code-group-panel>*{margin:0!important;border:0!important;border-radius:0 0 12px 12px;box-shadow:none!important}.vm-code-group-panel[hidden]{display:none}.prose table{display:table}table{border-collapse:separate;border-spacing:0;border:1px solid #404045;border-radius:8px;width:fit-content!important}table td,table th{border-right:1px solid #404045;border-bottom:1px solid #404045;padding:12px 16px!important}table td:last-child,table th:last-child{border-right:none}table tr:last-child td{border-bottom:none}table th{background-color:#201e2c}table th:first-child{border-radius:8px 0 0 0}table th:last-child{border-radius:0 8px 0 0}[data-component-name=mermaid-controls-wrapper]{display:none!important}.mermaid svg .actor{fill:#17132e!important;stroke:#373352!important}.mermaid svg rect.actor{rx:6;ry:6}.mermaid svg text.actor>tspan{fill:#d3cff7!important}.mermaid svg .actor-line{stroke:#464359!important;stroke-width:1!important}.mermaid svg .messageLine0,.mermaid svg .messageLine1{stroke:#464359!important;stroke-width:1.5!important}.mermaid svg #arrowhead path,.mermaid svg [id$=-arrowhead] path{fill:#464359!important;stroke:#464359!important}.mermaid svg #crosshead path,.mermaid svg [id$=-crosshead] path{stroke:#464359!important}.mermaid svg .messageText{fill:#c7c6cc!important}.mermaid svg .activation0,.mermaid svg .activation1,.mermaid svg .activation2,.mermaid svg .note{fill:#17132e!important;stroke:#373352!important}.mermaid svg .loopText,.mermaid svg .loopText>tspan,.mermaid svg .noteText,.mermaid svg .noteText>tspan{fill:#c7c6cc!important}.mermaid svg .loopLine{stroke:#373352!important}.mermaid svg .labelBox,.mermaid svg .node circle,.mermaid svg .node ellipse,.mermaid svg .node path,.mermaid svg .node polygon,.mermaid svg .node rect{fill:#17132e!important;stroke:#373352!important}.mermaid svg .labelText,.mermaid svg .labelText>tspan{fill:#c7c6cc!important}.mermaid svg .sequenceNumber{fill:#d3cff7!important}.mermaid svg .node .label,.mermaid svg .nodeLabel{color:#d3cff7!important;fill:#d3cff7!important}.mermaid svg .flowchart-link{stroke:#464359!important}.mermaid svg .edge-label,.mermaid svg .edgeLabel{color:#c7c6cc!important;fill:#c7c6cc!important}.mermaid .labelBkg,.mermaid .labelBkg *{background:0 0!important}.mermaid svg .marker{fill:#464359!important;stroke:#464359!important}.dark #sidebar [data-active=true]{background-color:#141414!important;border-radius:6px}.deposit-demo{container-type:inline-size}.deposit-demo-loading{position:absolute;inset:0;display:grid;place-items:center;margin:0}.deposit-demo-stage:has(iframe[data-ready=true]) .deposit-demo-loading{visibility:hidden}@container (max-width: 411px){.deposit-demo-stage{--deposit-demo-height:629px}}"}],"page":{"pagePath":"api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer","slug":"/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer","pageMetadata":{"title":"Create or resume hosted verification for the session customer","description":"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A `pending` result with `nextAction` must be presented in an iframe; `pending` without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /compliance/verification","href":"/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A \", _jsx(_components.code, {\n children: \"pending\"\n }), \" result with \", _jsx(_components.code, {\n children: \"nextAction\"\n }), \" must be presented in an iframe; \", _jsx(_components.code, {\n children: \"pending\"\n }), \" without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.\"]\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":"Create or resume hosted verification for the session customer","description":"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A `pending` result with `nextAction` must be presented in an iframe; `pending` without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /compliance/verification","href":"/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Compliance"],"summary":"Create or resume hosted verification for the session customer","description":"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A `pending` result with `nextAction` must be presented in an iframe; `pending` without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.","security":["4af92858-6512-4bf9-9c8c-7643146e06b1"],"requestBody":"f2409be4-81fd-48b1-9fbc-495ed0c96b15","responses":{"200":"9741e76a-bea2-4e60-bee2-6614356a4137","400":"5b57a5c8-c122-4d9f-925c-671389e3fbf0","401":"5cc46fed-4fb4-4415-864c-259ba26273ef","403":"bfc63503-391d-42e9-8392-80d7b1cce592","404":"ec3270d3-16e0-4cb0-8e62-a43d22394769","500":"9eb54dce-4a06-4347-930c-a1632837abc4","502":"455934be-6f2b-4292-b55d-0db984145f59","503":"3d445321-5f42-45c5-9b20-e51aa95d3051"},"method":"post","type":"path","servers":["8f66a06e-c2d4-4cef-a88e-239d80d4392b"],"path":"/compliance/verification","baseUrlOptions":["https://v1.orchestrator.rhinestone.dev/deposit-processor"],"title":"Create or resume hosted verification for the session customer","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"currency":{"type":"string","enum":["EUR","USD"],"deprecated":true,"description":"Ignored. The customer is verified for both currencies; the residence they declare decides the account's (EUR inside SEPA, USD elsewhere).","uniqueKey":"currency","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"9741e76a-bea2-4e60-bee2-6614356a4137":{"description":"Hosted verification session","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["pending","completed","failed"],"description":"pending: present nextAction or await review; completed: already verified; failed: provider rejected. Interaction status only, never settlement.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"expiresAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"expiresAt","typeLabel":"string\u003cdate-time>"},"nextAction":{"type":"object","properties":{"type":{"type":"string","enum":["hosted"],"isRequired":true,"uniqueKey":"nextAction.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"nextAction.url","typeLabel":"string\u003curi>"},"presentation":{"type":"string","enum":["iframe"],"isRequired":true,"uniqueKey":"nextAction.presentation","typeLabel":"enum\u003cstring>"}},"required":["type","url","presentation"],"additionalProperties":false,"uniqueKey":"nextAction","typeLabel":"object"}},"required":["id","status","expiresAt"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"pending","expiresAt":"2023-11-07T05:31:56Z","nextAction":{"type":"hosted","url":"\u003cstring>","presentation":"iframe"}}}},"exampleType":"generated"}},"exampleType":"generated"},"5b57a5c8-c122-4d9f-925c-671389e3fbf0":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Deposit error code (e.g. `TOKEN-3`) when the refusal is one a deposit would also receive.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"uniqueKey":"details.items.[INDEX].path","typeLabel":"(string | number)[]"},"code":{"type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"required":["message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"message":"\u003cstring>","path":["\u003cstring>"],"code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"5cc46fed-4fb4-4415-864c-259ba26273ef":{"description":"Missing, malformed, or expired session token","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Deposit error code (e.g. `TOKEN-3`) when the refusal is one a deposit would also receive.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"uniqueKey":"details.items.[INDEX].path","typeLabel":"(string | number)[]"},"code":{"type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"required":["message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"message":"\u003cstring>","path":["\u003cstring>"],"code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"bfc63503-391d-42e9-8392-80d7b1cce592":{"description":"Session does not match the resolved customer, or the provider refused verification for this customer","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Deposit error code (e.g. `TOKEN-3`) when the refusal is one a deposit would also receive.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"uniqueKey":"details.items.[INDEX].path","typeLabel":"(string | number)[]"},"code":{"type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"required":["message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"message":"\u003cstring>","path":["\u003cstring>"],"code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ec3270d3-16e0-4cb0-8e62-a43d22394769":{"description":"Bank transfer by virtual account is not provisioned for this project","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Deposit error code (e.g. `TOKEN-3`) when the refusal is one a deposit would also receive.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"uniqueKey":"details.items.[INDEX].path","typeLabel":"(string | number)[]"},"code":{"type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"required":["message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"message":"\u003cstring>","path":["\u003cstring>"],"code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"9eb54dce-4a06-4347-930c-a1632837abc4":{"description":"Failed to create the verification session","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Deposit error code (e.g. `TOKEN-3`) when the refusal is one a deposit would also receive.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"uniqueKey":"details.items.[INDEX].path","typeLabel":"(string | number)[]"},"code":{"type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"required":["message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"message":"\u003cstring>","path":["\u003cstring>"],"code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"455934be-6f2b-4292-b55d-0db984145f59":{"description":"The verification provider rejected or failed the request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Deposit error code (e.g. `TOKEN-3`) when the refusal is one a deposit would also receive.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"uniqueKey":"details.items.[INDEX].path","typeLabel":"(string | number)[]"},"code":{"type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"required":["message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"message":"\u003cstring>","path":["\u003cstring>"],"code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"3d445321-5f42-45c5-9b20-e51aa95d3051":{"description":"Verification provider not configured, or sessions paused","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Deposit error code (e.g. `TOKEN-3`) when the refusal is one a deposit would also receive.","uniqueKey":"code","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"details.items.[INDEX].message","typeLabel":"string"},"path":{"type":"array","items":{"oneOf":[{"type":"string","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"details.items.[INDEX].path.items.[INDEX].oneOf.1","typeLabel":"number"}],"uniqueKey":"details.items.[INDEX].path.items.[INDEX]","typeLabel":"string | number"},"uniqueKey":"details.items.[INDEX].path","typeLabel":"(string | number)[]"},"code":{"type":"string","uniqueKey":"details.items.[INDEX].code","typeLabel":"string"}},"required":["message"],"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","details":[{"message":"\u003cstring>","path":["\u003cstring>"],"code":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4af92858-6512-4bf9-9c8c-7643146e06b1":{"complianceSessionBearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Required 15-minute customer-scoped browser session from POST /compliance/sessions. Application keys are not accepted.","scopes":[],"schemeName":"complianceSessionBearer"}}},"servers":{"8f66a06e-c2d4-4cef-a88e-239d80d4392b":{"url":"https://v1.orchestrator.rhinestone.dev/deposit-processor"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Required 15-minute customer-scoped browser session from POST /compliance/sessions. Application keys are not accepted.","scopes":[],"schemeName":"complianceSessionBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Required 15-minute customer-scoped browser session from POST /compliance/sessions. Application keys are not accepted.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"complianceSessionBearer","name":"Authorization"}],"title":"complianceSessionBearer"}]},"originalFileLocation":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json"},"subdomain":"rhinestone","siteName":"Rhinestone","title":"Create or resume hosted verification for the session customer - Rhinestone","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-16T14:47:21.498Z","originalFileLocation":"api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";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=\"dark\"}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=\"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A pending result with nextAction must be presented in an iframe; pending without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Rhinestone\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create or resume hosted verification for the session customer - Rhinestone\">\u003cmeta data-mint-head property=\"og:description\" content=\"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A pending result with nextAction must be presented in an iframe; pending without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Rhinestone\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://rhinestone.mintlify.app/_mintlify/api/og/v2?division=Compliance\u0026amp;title=Create+or+resume+hosted+verification+for+the+session+customer\u0026amp;description=Browser+route.+Starts+or+resumes+the+provider-hosted+verification+flow+for+the+compliance+customer+named+by+the+session+bearer.+A+%60pending%60+result+with+%60nextAct\u0026amp;theme=480304d2cd15a3be6f477401\u0026amp;signature=2002c1251e3c1b36c2280188a04e2828c5f3cd613c5c4fda7ee078bf8766617d\">\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=\"Create or resume hosted verification for the session customer - Rhinestone\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A pending result with nextAction must be presented in an iframe; pending without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://rhinestone.mintlify.app/_mintlify/api/og/v2?division=Compliance\u0026amp;title=Create+or+resume+hosted+verification+for+the+session+customer\u0026amp;description=Browser+route.+Starts+or+resumes+the+provider-hosted+verification+flow+for+the+compliance+customer+named+by+the+session+bearer.+A+%60pending%60+result+with+%60nextAct\u0026amp;theme=480304d2cd15a3be6f477401\u0026amp;signature=2002c1251e3c1b36c2280188a04e2828c5f3cd613c5c4fda7ee078bf8766617d\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/rhinestone/3aadr-awyf35tysK/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Rhinestone\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4f41ef\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.rhinestone.dev/#organization\",\"name\":\"Rhinestone\",\"url\":\"https://docs.rhinestone.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/rhinestone/IVpDy9zUkncYAe5u/logo/light.svg?fit=max\u0026auto=format\u0026n=IVpDy9zUkncYAe5u\u0026q=85\u0026s=6868a5854576ff60d371d5fdc0ae55c9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.rhinestone.dev#website\",\"name\":\"Rhinestone\",\"url\":\"https://docs.rhinestone.dev\",\"publisher\":{\"@id\":\"https://docs.rhinestone.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer#webpage\",\"url\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer\",\"name\":\"Create or resume hosted verification for the session customer\",\"description\":\"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A pending result with nextAction must be presented in an iframe; pending without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.\",\"dateModified\":\"2026-10-16T14:47:21.498Z\",\"isPartOf\":{\"@id\":\"https://docs.rhinestone.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Deposits\",\"item\":\"https://docs.rhinestone.dev/api-reference/deposit-service/analytics/record-analytics-events\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Compliance\",\"item\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-a-compliance-customer-and-mint-a-scoped-session\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create or resume hosted verification for the session customer\",\"item\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer#apireference\",\"headline\":\"Create or resume hosted verification for the session customer\",\"name\":\"Create or resume hosted verification for the session customer\",\"description\":\"Browser route. Starts or resumes the provider-hosted verification flow for the compliance customer named by the session bearer. A pending result with nextAction must be presented in an iframe; pending without it means the provider is reviewing and status updates arrive via webhook. The hosted URL is short-lived and is never stored — call again to mint a fresh one.\",\"url\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer\",\"mainEntityOfPage\":{\"@id\":\"https://docs.rhinestone.dev/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer#webpage\"},\"dateModified\":\"2026-10-16T14:47:21.498Z\",\"publisher\":{\"@id\":\"https://docs.rhinestone.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.rhinestone.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Rhinestone\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Rhinestone","nav":{"global":{"anchors":[{"anchor":"Create API Key","icon":"key","href":"https://tally.so/r/wg22x4"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home/introduction"}]},{"tab":"Wallets","menu":[{"item":"Overview","pages":[{"title":"Overview","href":"/wallets/overview"}]},{"item":"Embedded wallets","pages":[{"title":"Embedded wallets","href":"/wallets/embedded-wallets/overview"}]},{"item":"Session keys","pages":[{"title":"Session keys","href":"/wallets/session-keys/overview"}]},{"item":"Recovery","pages":[{"title":"Recovery","href":"/wallets/recovery/overview"}]},{"item":"Custom signer","pages":[{"title":"Custom signer","href":"/wallets/custom-signer/overview"}]}],"pages":[{"title":"Wallets","href":"/wallets/overview"}]},{"tab":"Transactions","menu":[{"item":"Overview","pages":[{"title":"Overview","href":"/transactions/overview"}]},{"item":"Relaying","pages":[{"title":"Relaying","href":"/transactions/relaying/overview"}]},{"item":"Multichain","pages":[{"title":"Multichain","href":"/transactions/multichain/overview"}]},{"item":"Trading","pages":[{"title":"Trading","href":"/transactions/trading/overview"}]},{"item":"Sponsorship \u0026 monetization","pages":[{"title":"Sponsorship \u0026 monetization","href":"/transactions/sponsorship/overview"}]}],"pages":[{"title":"Transactions","href":"/transactions/overview"}]},{"tab":"Deposits","menu":[{"item":"Overview","pages":[{"title":"Overview","href":"/deposits/overview/overview"}]},{"item":"Onramps","pages":[{"title":"Onramps","href":"/deposits/onramps/overview"}]},{"item":"Crypto","pages":[{"title":"Crypto","href":"/deposits/crypto/overview"}]},{"item":"Exchanges","pages":[{"title":"Exchanges","href":"/deposits/exchanges/overview"}]},{"item":"Headless","pages":[{"title":"Headless","href":"/deposits/headless/overview"}]}],"pages":[{"title":"Deposits","href":"/deposits/overview/overview"}]},{"tab":"Fiat integrations","pages":[{"title":"Fiat integrations","href":"/fiat/overview"}]},{"tab":"API Reference","groups":[{"group":"Get started","public":true,"pages":[{"title":"Introduction","href":"/api-reference/introduction"},{"title":"Versioning","href":"/api-reference/api-versioning"}]},{"group":"Intents","public":true,"pages":[{"group":"Utilities","pages":[{"title":"Supported chains and tokens","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /chains","href":"/api-reference/orchestrator/utilities/supported-chains-and-tokens"},{"title":"Route liquidity limit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /liquidity","href":"/api-reference/orchestrator/utilities/route-liquidity-limit"},{"title":"Get Account Portfolio","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /accounts/{accountAddress}/portfolio","href":"/api-reference/orchestrator/utilities/get-account-portfolio"}]},{"group":"Intents","pages":[{"title":"Get Intent","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /intents/{id}","href":"/api-reference/orchestrator/intents/get-intent"},{"title":"List Intents","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /intents","href":"/api-reference/orchestrator/intents/list-intents"},{"title":"Create Intent","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json post /intents","href":"/api-reference/orchestrator/intents/create-intent"},{"title":"Split Intent by Liquidity","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json post /intents/splits","href":"/api-reference/orchestrator/intents/split-intent-by-liquidity"}]},{"group":"Quotes","pages":[{"title":"Create Quote","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json post /quotes","href":"/api-reference/orchestrator/quotes/create-quote"},{"title":"Create Indicative Quote","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json post /quotes/estimate","href":"/api-reference/orchestrator/quotes/create-indicative-quote"}]},{"group":"App Fees","pages":[{"title":"Get App-Fee Balances","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /app-fees/balances","href":"/api-reference/orchestrator/app-fees/get-app-fee-balances"},{"title":"Get App-Fee Withdrawal Targets","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /app-fees/withdrawal-targets","href":"/api-reference/orchestrator/app-fees/get-app-fee-withdrawal-targets"},{"title":"List App-Fee Withdrawals","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /app-fees/withdrawals","href":"/api-reference/orchestrator/app-fees/list-app-fee-withdrawals"},{"title":"Create App-Fee Withdrawal","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json post /app-fees/withdrawals","href":"/api-reference/orchestrator/app-fees/create-app-fee-withdrawal"},{"title":"Get App-Fee Withdrawal","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/orchestrator/caucasus.json get /app-fees/withdrawals/{nonce}","href":"/api-reference/orchestrator/app-fees/get-app-fee-withdrawal"}]}]},{"group":"Deposits","public":true,"pages":[{"group":"Analytics","pages":[{"title":"Record analytics events","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /analytics/events","href":"/api-reference/deposit-service/analytics/record-analytics-events"},{"title":"Create an analytics token","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /analytics/ingest-token","href":"/api-reference/deposit-service/analytics/create-an-analytics-token"}]},{"group":"Utilities","pages":[{"title":"Get asset metadata","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /assets","href":"/api-reference/deposit-service/utilities/get-asset-metadata"},{"title":"List supported chains and tokens","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /chains","href":"/api-reference/deposit-service/utilities/list-supported-chains-and-tokens"},{"title":"List deposits","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /deposits","href":"/api-reference/deposit-service/utilities/list-deposits"},{"title":"Get a deposit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /deposits/{id}","href":"/api-reference/deposit-service/utilities/get-a-deposit"},{"title":"List deposit quotes","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /deposits/{id}/quotes","href":"/api-reference/deposit-service/utilities/list-deposit-quotes"},{"title":"Get deposit statistics","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /deposits/stats","href":"/api-reference/deposit-service/utilities/get-deposit-statistics"},{"title":"Get a wallet portfolio","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /portfolio/{address}","href":"/api-reference/deposit-service/utilities/get-a-wallet-portfolio"},{"title":"List withdrawable positions","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /positions/{address}","href":"/api-reference/deposit-service/utilities/list-withdrawable-positions"},{"title":"Prepare an Aave withdrawal","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /positions/{address}/unwind","href":"/api-reference/deposit-service/utilities/prepare-an-aave-withdrawal"},{"title":"Get a Solana wallet portfolio","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /portfolio/solana/{address}","href":"/api-reference/deposit-service/utilities/get-a-solana-wallet-portfolio"},{"title":"Check route liquidity","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /liquidity","href":"/api-reference/deposit-service/utilities/check-route-liquidity"},{"title":"Get token prices","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /prices","href":"/api-reference/deposit-service/utilities/get-token-prices"},{"title":"List suggested deposit tokens","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /qr/tokens","href":"/api-reference/deposit-service/utilities/list-suggested-deposit-tokens"}]},{"group":"Accounts","pages":[{"title":"Check account registration","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /check/{address}","href":"/api-reference/deposit-service/accounts/check-account-registration"},{"title":"Register an account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /register","href":"/api-reference/deposit-service/accounts/register-an-account"},{"title":"Provision deposit addresses","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /account/{address}/deposit-addresses","href":"/api-reference/deposit-service/accounts/provision-deposit-addresses"},{"title":"Add session details to account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /account/{address}/session","href":"/api-reference/deposit-service/accounts/add-session-details-to-account"},{"title":"Provision a Solana token account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /account/{address}/token-accounts","href":"/api-reference/deposit-service/accounts/provision-a-solana-token-account"},{"title":"Register a managed account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /register-managed","href":"/api-reference/deposit-service/accounts/register-a-managed-account"},{"title":"Prepare account registration","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /setup-account","href":"/api-reference/deposit-service/accounts/prepare-account-registration"}]},{"group":"Clients","pages":[{"title":"Get client settings","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /setup","href":"/api-reference/deposit-service/clients/get-client-settings"},{"title":"Update client settings","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /setup","href":"/api-reference/deposit-service/clients/update-client-settings"}]},{"group":"Processing","pages":[{"title":"Retry a deposit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /deposits/{id}/retry","href":"/api-reference/deposit-service/processing/retry-a-deposit"},{"title":"Refund a deposit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /deposits/{id}/refund","href":"/api-reference/deposit-service/processing/refund-a-deposit"},{"title":"Recover a deposit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /deposits/recover","href":"/api-reference/deposit-service/processing/recover-a-deposit"},{"title":"Get a deposit quote","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /quotes/preview","href":"/api-reference/deposit-service/processing/get-a-deposit-quote"},{"title":"Prepare a gasless deposit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /deposits/permit/prepare","href":"/api-reference/deposit-service/processing/prepare-a-gasless-deposit"},{"title":"Submit a gasless deposit","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /deposits/permit","href":"/api-reference/deposit-service/processing/submit-a-gasless-deposit"},{"title":"Relay a Safe withdrawal","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /safe/withdraw","href":"/api-reference/deposit-service/processing/relay-a-safe-withdrawal"},{"title":"Relay a Polymarket withdrawal","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /polymarket/withdraw","href":"/api-reference/deposit-service/processing/relay-a-polymarket-withdrawal"}]},{"group":"Webhooks","pages":[{"title":"List webhook events","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /webhooks/events","href":"/api-reference/deposit-service/webhooks/list-webhook-events"},{"title":"Resend a webhook","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /webhooks/events/{id}/resend","href":"/api-reference/deposit-service/webhooks/resend-a-webhook"},{"title":"Send a test webhook","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /webhooks/test","href":"/api-reference/deposit-service/webhooks/send-a-test-webhook"}]},{"group":"Compliance","pages":[{"title":"Create or resume a compliance customer and mint a scoped session","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /compliance/sessions","href":"/api-reference/deposit-service/compliance/create-or-resume-a-compliance-customer-and-mint-a-scoped-session"},{"title":"Read the canonical verification state for the session customer","description":"Browser route. Returns the normalized verification state for the compliance customer named by the session bearer. Scoped to that one customer — a token can never read another customer, project, or bound account.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /compliance/status","href":"/api-reference/deposit-service/compliance/read-the-canonical-verification-state-for-the-session-customer"},{"title":"Create or resume hosted verification for the session customer","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /compliance/verification","href":"/api-reference/deposit-service/compliance/create-or-resume-hosted-verification-for-the-session-customer"}]},{"group":"Onramp","pages":[{"title":"List onramp providers","description":"The onramps provisioned for this organization, and the credential each takes. Ask `GET /onramp/options` what each one offers.","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/providers","href":"/api-reference/deposit-service/onramp/list-onramp-providers"},{"title":"Get an onramp order","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/orders/{id}","href":"/api-reference/deposit-service/onramp/get-an-onramp-order"},{"title":"List onramp orders","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/orders","href":"/api-reference/deposit-service/onramp/list-onramp-orders"},{"title":"Start an onramp order","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /onramp/orders","href":"/api-reference/deposit-service/onramp/start-an-onramp-order"},{"title":"List onramp options","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/options","href":"/api-reference/deposit-service/onramp/list-onramp-options"},{"title":"List funding accounts","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/accounts","href":"/api-reference/deposit-service/onramp/list-funding-accounts"},{"title":"Set up a funding account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /onramp/accounts","href":"/api-reference/deposit-service/onramp/set-up-a-funding-account"},{"title":"Get a funding account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/accounts/{id}","href":"/api-reference/deposit-service/onramp/get-a-funding-account"},{"title":"Get bank details for a funding account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /onramp/accounts/{id}/details","href":"/api-reference/deposit-service/onramp/get-bank-details-for-a-funding-account"}]},{"group":"Offramp","pages":[{"title":"List payout methods","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /offramp/options","href":"/api-reference/deposit-service/offramp/list-payout-methods"},{"title":"List offramp orders","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /offramp/orders","href":"/api-reference/deposit-service/offramp/list-offramp-orders"},{"title":"Start a withdrawal to a bank account","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json post /offramp/orders","href":"/api-reference/deposit-service/offramp/start-a-withdrawal-to-a-bank-account"},{"title":"Get an offramp order","deprecated":null,"version":null,"openapi":"https://raw.githubusercontent.com/rhinestonewtf/openapi/refs/heads/main/deposit-service.json get /offramp/orders/{id}","href":"/api-reference/deposit-service/offramp/get-an-offramp-order"}]}]}]}]},"basePath":"","title":"Create or resume hosted verification for the session customer - Rhinestone","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DCDCdBVX.js","utils-ME8dDnLe.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-0e84ACsd.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-wgRBj-ia.js","snippetPresets-C11Sgb-o.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-C0lapOpP.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ZeRQV8fF.js","shallow-BupWh095.js","getApiPlaygroundDisplay-BnYQO2Ss.js","CodeSnippet-RKKOc8c_.js","CodeSnippets-Drf_m8wS.js","Page-Bevw23-4.js","getPastedJson-u6QiPzNZ.js","icon-Bb-CBSxO.js","MethodPill-F7l5AI7V.js","DuplicateIcon-IiAXkdSg.js","createIcon-FliI8EBc.js","DynamicMarkdown-B62XqCSI.js","SectionHeading-Dj31pT03.js","axios-vUo_bRtp.js","Markdown-BOgQCTwD.js","clsx-BIWXJmsZ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DKZWslLH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-UDqbR6xh.js"]}