{
"error": {
"code": "SESSION_INVALID_STATUS_TRANSITION",
"message": "This call is accepted only while the verification is in progress.",
"details": {
"currentStatus": "completed",
"resultCode": "RECEIVED",
"verificationId": "019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8",
"allowed_statuses": [
"initiated",
"awaiting_user_action"
]
}
},
"request_id": "7c1e4a92-5b3d-4f8e-a6c0-2d9b81f3e547"
}
Cancels a verification session. The session ends as failed with result.codeCLIENT_CANCELLED and can no longer be completed by the user. It stays readable through Get Verification Status.
Unknown id, a session of another app, or an environment mismatch
409
SESSION_INVALID_STATUS_TRANSITION
The session is already completed or failed
Cancelling does not notify the eID provider. A provider-side session the user already opened may stay alive until it expires on its own, but its result will never be applied to the cancelled verification.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"hConnect","colors":{"primary":"#2563EB","light":"#71717A","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/hopae-a83466ba/ZQEdy_FTEqcDCNky/logo/hconnect_light.png?fit=max\u0026auto=format\u0026n=ZQEdy_FTEqcDCNky\u0026q=85\u0026s=b55f8449a1816421b47a12dfaf0346ad","dark":"https://mintcdn.com/hopae-a83466ba/ZQEdy_FTEqcDCNky/logo/hconnect_dark.png?fit=max\u0026auto=format\u0026n=ZQEdy_FTEqcDCNky\u0026q=85\u0026s=637f0017e4b0ccc77fd6e28d5b177afe"},"favicon":"https://mintcdn.com/hopae-a83466ba/Ic1oE8rFNW-qnQGv/hopae.svg?fit=max\u0026auto=format\u0026n=Ic1oE8rFNW-qnQGv\u0026q=85\u0026s=eb81cb989e33aeaf7c15a3a8567492ca","api":{"openapi":["v2/openapi.json","v2/openapi-oidc.json"],"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]},"mdx":{"auth":{"method":"basic"},"server":"https://sandbox.api.hopae.com/connect/v1"}},"navbar":{"primary":{"type":"button","label":"Console","href":"https://console.hopae.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hopae-a83466ba","hasAudioNarration":false,"actualSubdomain":"hopae-a83466ba","customDomains":["docs.hopae.com"],"gitSource":{"type":"github","owner":"hopae-official","repo":"hconnect-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b000b3057be3405cca92641","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Guides","count":52},{"language":"default","tag":"Verification API","count":32},{"language":"default","tag":"Workspace API","count":21},{"language":"default","tag":"Concepts","count":13},{"language":"default","tag":"Reference","count":12},{"language":"default","tag":"OIDC","count":11},{"language":"default","tag":"Verifications","count":11},{"language":"default","tag":"Overview","count":10},{"language":"default","tag":"Apps","count":9},{"language":"default","tag":"REST API","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"page-tags.css","content":"html:has(#sidebar-content a.bg-primary\\/10 [data-nav-tag=\"Sandbox\"]) #page-title::after{content:\"Sandbox\";display:inline-block;margin-left:0.625rem;padding:0.125rem 0.5rem;border-radius:0.375rem;font-size:0.875rem;font-weight:700;line-height:1.25rem;letter-spacing:normal;vertical-align:middle;color:rgb(var(--primary));background-color:rgb(var(--primary) / 0.1)}html.dark:has(#sidebar-content a.bg-primary\\/10 [data-nav-tag=\"Sandbox\"]) #page-title::after{color:rgb(var(--primary-light));background-color:rgb(var(--primary-light) / 0.1)}"}]}
{"page":{"pagePath":"v2/api-reference/verifications/cancel-verification","slug":"/v2/api-reference/verifications/cancel-verification","pageMetadata":{"title":"Cancel Verification","description":"Cancel a verification session that has not finished.","openapi":"DELETE /verifications/{verificationId}","href":"/v2/api-reference/verifications/cancel-verification"},"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: \"Cancel a verification session that has not finished.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Heading,Note,ParamField,Table}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!ParamField)_missingMdxReference(`ParamField`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Cancels a verification session. The session ends as `,_jsx(_components.code,{children:`failed`}),` with `,_jsx(_components.code,{children:`result.code`}),` `,_jsx(_components.code,{children:`CLIENT_CANCELLED`}),` and can no longer be completed by the user. It stays readable through `,_jsx(_components.a,{href:`/v2/api-reference/verifications/get-verification`,children:`Get Verification Status`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`headers`,children:`Headers`}),`\n`,_jsx(ParamField,{header:`Authorization`,type:`string`,required:true,id:`param-authorization`,children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`Basic \u003cbase64(appId:appSecret)>`}),`. See `,_jsx(_components.a,{href:`/v2/api-reference/authentication`,children:`Authentication`}),`.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`path-parameters`,children:`Path Parameters`}),`\n`,_jsx(ParamField,{path:`verificationId`,type:`string`,required:true,id:`param-verification-id`,children:_jsx(_components.p,{children:`The session id.`})}),`\n`,_jsx(Heading,{level:`2`,id:`response`,children:`Response`}),`\n`,_jsxs(_components.p,{children:[`Returns an empty response with HTTP status `,_jsx(_components.code,{children:`204`}),` on success.`]}),`\n`,`\n`,_jsx(Heading,{level:`2`,id:`errors`,children:`Errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{style:{textAlign:`left`},children:`HTTP`}),_jsx(_components.th,{style:{textAlign:`left`},children:`Code`}),_jsx(_components.th,{style:{textAlign:`left`},children:`When`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`404`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`SESSION_VERIFICATION_NOT_FOUND`})}),_jsx(_components.td,{style:{textAlign:`left`},children:`Unknown id, a session of another app, or an environment mismatch`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,style:{textAlign:`left`},children:`409`}),_jsx(_components.td,{style:{textAlign:`left`},children:_jsx(_components.code,{children:`SESSION_INVALID_STATUS_TRANSITION`})}),_jsxs(_components.td,{style:{textAlign:`left`},children:[`The session is already `,_jsx(_components.code,{children:`completed`}),` or `,_jsx(_components.code,{children:`failed`})]})]})]})]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`Cancelling does not notify the eID provider. A provider-side session the user already opened may stay alive until it expires on its own, but its result will never be applied to the cancelled verification.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Cancel Verification","description":"Cancel a verification session that has not finished.","openapi":"DELETE /verifications/{verificationId}","href":"/v2/api-reference/verifications/cancel-verification"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[205,223,"pre:`pre`,span:`span`,tbody:`tbody`,td:`"],[303,345,"CodeBlock,Heading,Note,ParamField,RequestExample,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true)"],[497,514,"RequestExample)_missingMdxReference(`RequestExample`,true);if(!Table)_missingMdx"],[1825,1832,"_jsx(RequestExample,{children:_jsx(CodeBlock,{filename:`cURL`,numberOfLines:`3`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --request`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` DELETE`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --url`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 'https://api.hopae.com/connect/v2/verifications/{verificationId}'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --user`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{appId}:{appSecret}'`})]}),`\n`]})})})}),`\n`,_js"]]},"mdxExtracts":{"tableOfContents":[{"title":"Headers","slug":"headers","depth":2,"children":[]},{"title":"Path Parameters","slug":"path-parameters","depth":2,"children":[]},{"title":"Response","slug":"response","depth":2,"children":[]},{"title":"Errors","slug":"errors","depth":2,"children":[]}],"codeExamples":{"request":{"type":"RequestExample","children":[{"filename":"cURL","html":"\u003cpre class=\"shiki shiki-themes github-light-default dark-plus\" style=\"background-color:#ffffff;--shiki-dark-bg:#0B0C0E;color:#1f2328;--shiki-dark:#D4D4D4\" language=\"shellscript\">\u003ccode language=\"shellscript\" numberOfLines=\"3\">\u003cspan class=\"line\">\u003cspan style=\"color:#953800;--shiki-dark:#DCDCAA\">curl\u003c/span>\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --request\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> DELETE\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --url\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> 'https://api.hopae.com/connect/v2/verifications/{verificationId}'\u003c/span>\u003cspan style=\"color:#CF222E;--shiki-dark:#D7BA7D\"> \\\u003c/span>\u003c/span>\n\u003cspan class=\"line\">\u003cspan style=\"color:#0550AE;--shiki-dark:#569CD6\"> --user\u003c/span>\u003cspan style=\"color:#0A3069;--shiki-dark:#CE9178\"> '{appId}:{appSecret}'\u003c/span>\u003c/span>\n\u003c/code>\u003c/pre>"}],"attributes":[]}}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Verifications"],"summary":"Cancel Verification","operationId":"cancelVerification","parameters":["01985d83-350f-461b-a3c7-e084f630c0ee"],"responses":{"204":"2103efa6-3efb-45a9-a538-8f789c1af6de","404":"b06c9fcc-736b-457d-9e13-bee9c29d686a","409":"3c78d40b-1dfd-41df-8d20-2c5fff330dc8"},"method":"delete","type":"path","servers":["67f8b9f8-1306-4d8a-8642-965ee9613340"],"security":["11021054-ee09-4372-b9e0-3a17ec70f141"],"path":"/verifications/{verificationId}","baseUrlOptions":["https://api.hopae.com/connect/v2"],"title":"Cancel Verification","description":"Cancel a verification session that has not finished.","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExamples":[{"dropdown":false,"language":"shellscript","code":{"type":"pre","key":null,"ref":null,"props":{"className":"shiki shiki-themes github-light-default dark-plus","style":{"backgroundColor":"#ffffff","--shiki-dark-bg":"#0B0C0E","color":"#1f2328","--shiki-dark":"#D4D4D4"},"language":"shellscript","children":{"type":"code","key":null,"ref":null,"props":{"language":"shellscript","numberOfLines":"3","children":[{"type":"span","key":"0","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#953800","--shiki-dark":"#DCDCAA"},"children":"curl"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --request"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" DELETE"}},{"type":"span","key":"3","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"2","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --url"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" 'https://api.hopae.com/connect/v2/verifications/{verificationId}'"}},{"type":"span","key":"2","ref":null,"props":{"style":{"color":"#CF222E","--shiki-dark":"#D7BA7D"},"children":" \\"}}]}},"\n",{"type":"span","key":"4","ref":null,"props":{"className":"line","children":[{"type":"span","key":"0","ref":null,"props":{"style":{"color":"#0550AE","--shiki-dark":"#569CD6"},"children":" --user"}},{"type":"span","key":"1","ref":null,"props":{"style":{"color":"#0A3069","--shiki-dark":"#CE9178"},"children":" '{appId}:{appSecret}'"}}]}},"\n"]}}}},"filename":"cURL"}],"requestExampleType":"mdx","responseExampleType":"generated"},"dependencies":{"parameters":{"01985d83-350f-461b-a3c7-e084f630c0ee":{"name":"verificationId","in":"path","required":true,"description":"The session id.","schema":{"type":"string","isRequired":true,"description":"The session id.","uniqueKey":"","typeLabel":"string"}}},"responses":{"2103efa6-3efb-45a9-a538-8f789c1af6de":{"description":"Cancelled.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"b06c9fcc-736b-457d-9e13-bee9c29d686a":{"description":"`SESSION_VERIFICATION_NOT_FOUND`: unknown id, or created on another mode.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SESSION_VERIFICATION_NOT_FOUND","message":"Verification not found","details":{}},"request_id":"7c1e4a92-5b3d-4f8e-a6c0-2d9b81f3e547"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SESSION_VERIFICATION_NOT_FOUND","message":"Verification not found","details":{}},"request_id":"7c1e4a92-5b3d-4f8e-a6c0-2d9b81f3e547"}}},"exampleType":"examples"}},"exampleType":"examples"},"3c78d40b-1dfd-41df-8d20-2c5fff330dc8":{"description":"`SESSION_INVALID_STATUS_TRANSITION`: the session has already ended.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"},"request_id":{"type":"string","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SESSION_INVALID_STATUS_TRANSITION","message":"This call is accepted only while the verification is in progress.","details":{"currentStatus":"completed","resultCode":"RECEIVED","verificationId":"019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8","allowed_statuses":["initiated","awaiting_user_action"]}},"request_id":"7c1e4a92-5b3d-4f8e-a6c0-2d9b81f3e547"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SESSION_INVALID_STATUS_TRANSITION","message":"This call is accepted only while the verification is in progress.","details":{"currentStatus":"completed","resultCode":"RECEIVED","verificationId":"019bc4f2-8a31-7c5e-9d02-4f7a1b3e60d8","allowed_statuses":["initiated","awaiting_user_action"]}},"request_id":"7c1e4a92-5b3d-4f8e-a6c0-2d9b81f3e547"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"11021054-ee09-4372-b9e0-3a17ec70f141":{"basicAuth":{"type":"http","scheme":"basic","description":"`Basic base64(appId:appSecret)`. See [Authentication](/v2/api-reference/authentication).","scopes":[],"schemeName":"basicAuth"}}},"servers":{"67f8b9f8-1306-4d8a-8642-965ee9613340":{"url":"https://api.hopae.com/connect/v2","description":"Hopae Connect"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"`Basic base64(appId:appSecret)`. See [Authentication](/v2/api-reference/authentication).","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"`Basic base64(appId:appSecret)`. See [Authentication](/v2/api-reference/authentication).","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"v2/openapi.json"},"subdomain":"hopae-a83466ba","siteName":"hConnect","title":"Cancel Verification - hConnect","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/api-reference/verifications/cancel-verification","matchLevel":0},"v1":{"href":"/api-reference/verifications/cancel-verification","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-11-19T09:32:08.154Z","originalFileLocation":"v2/api-reference/verifications/cancel-verification.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=\"Cancel a verification session that has not finished.\">\u003cmeta data-mint-head name=\"application-name\" content=\"hConnect\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hopae-a83466ba/ZlLEDy_twj3SXOqy/_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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hopae-a83466ba/ZlLEDy_twj3SXOqy/_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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Cancel Verification - hConnect\">\u003cmeta data-mint-head property=\"og:description\" content=\"Cancel a verification session that has not finished.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"hConnect\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hopae-a83466ba.mintlify.site/_mintlify/api/og/v2?division=Verifications\u0026amp;title=Cancel+Verification\u0026amp;description=Cancel+a+verification+session+that+has+not+finished.\u0026amp;theme=bcfc15a264d2f9d377d575f8\u0026amp;signature=5491146d160ed8d7695ffcf4d3240b6c499b2ee84dd1c22e487c8939e95160ce\">\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=\"Cancel Verification - hConnect\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Cancel a verification session that has not finished.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hopae-a83466ba.mintlify.site/_mintlify/api/og/v2?division=Verifications\u0026amp;title=Cancel+Verification\u0026amp;description=Cancel+a+verification+session+that+has+not+finished.\u0026amp;theme=bcfc15a264d2f9d377d575f8\u0026amp;signature=5491146d160ed8d7695ffcf4d3240b6c499b2ee84dd1c22e487c8939e95160ce\">\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/hopae-a83466ba/ZlLEDy_twj3SXOqy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"hConnect\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/verifications/cancel-verification.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hopae.com/#organization\",\"name\":\"hConnect\",\"url\":\"https://docs.hopae.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hopae-a83466ba/ZQEdy_FTEqcDCNky/logo/hconnect_light.png?fit=max\u0026auto=format\u0026n=ZQEdy_FTEqcDCNky\u0026q=85\u0026s=b55f8449a1816421b47a12dfaf0346ad\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hopae.com#website\",\"name\":\"hConnect\",\"url\":\"https://docs.hopae.com\",\"publisher\":{\"@id\":\"https://docs.hopae.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification#webpage\",\"url\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification\",\"name\":\"Cancel Verification\",\"description\":\"Cancel a verification session that has not finished.\",\"dateModified\":\"2026-11-19T09:32:08.154Z\",\"isPartOf\":{\"@id\":\"https://docs.hopae.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Verifications\",\"item\":\"https://docs.hopae.com/v2/api-reference/verifications/base-url\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Cancel Verification\",\"item\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification#apireference\",\"headline\":\"Cancel Verification\",\"name\":\"Cancel Verification\",\"description\":\"Cancel a verification session that has not finished.\",\"url\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hopae.com/v2/api-reference/verifications/cancel-verification#webpage\"},\"dateModified\":\"2026-11-19T09:32:08.154Z\",\"publisher\":{\"@id\":\"https://docs.hopae.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hopae.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"hConnect\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"hConnect\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/v2/api-reference/verifications/cancel-verification.md","siteName":"hConnect","nav":{"global":null,"versions":[{"version":"v2","default":true,"hidden":false,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/v2/guides/getting-started/introduction"}]},{"tab":"Verification API","icon":"square-terminal","groups":[{"group":"Overview","pages":[{"title":"API Overview","sidebarTitle":"Introduction","href":"/v2/api-reference/introduction"},{"title":"Authentication","href":"/v2/api-reference/authentication"},{"title":"Error Code Reference","sidebarTitle":"Error Codes","href":"/v2/api-reference/error-codes"}]},{"group":"OIDC","pages":[{"title":"Base URL","href":"/v2/api-reference/oidc/base-url"},{"title":"Discovery Document","openapi":"GET /.well-known/openid-configuration","href":"/v2/api-reference/oidc/well-known"},{"title":"Start Authorization","openapi":"GET /auth","href":"/v2/api-reference/oidc/auth"},{"title":"Exchange Code for Token","sidebarTitle":"Token","openapi":"POST /token","href":"/v2/api-reference/oidc/token"},{"title":"UserInfo","openapi":"GET /userinfo","href":"/v2/api-reference/oidc/userinfo"},{"title":"JWKS","openapi":"GET /jwks","href":"/v2/api-reference/oidc/jwks"}]},{"group":"Verifications","pages":[{"title":"Base URL","href":"/v2/api-reference/verifications/base-url"},{"title":"Get Connections","openapi":"GET /connections","href":"/v2/api-reference/verifications/get-connections"},{"title":"Create Verification","openapi":"POST /verifications","href":"/v2/api-reference/verifications/create-verification"},{"title":"Get Verification Status","openapi":"GET /verifications/{verificationId}","href":"/v2/api-reference/verifications/get-verification"},{"title":"Get Verification UserInfo","description":"Return the verified claims for a verification whose result code is RECEIVED, and on request the provenance and missing claims.","openapi":"GET /verifications/{verificationId}/userinfo","href":"/v2/api-reference/verifications/get-verification-userinfo"},{"title":"Cancel Verification","openapi":"DELETE /verifications/{verificationId}","href":"/v2/api-reference/verifications/cancel-verification"},{"title":"User Input","sidebarTitle":"User Input","description":"How to fill the userInput field when you create a verification. The schema comes from the connection, not from a fixed list of providers.","href":"/v2/api-reference/verifications/user-input"}]},{"group":"Provider-specific","pages":[{"title":"List iDIN Banks","openapi":"GET /providers/idin/banks","href":"/v2/api-reference/provider-specific/idin/list-banks"}]}]},{"tab":"Workspace API","icon":"square-terminal","pages":[{"title":"Workspace API","href":"/v2/api-reference/workspace/introduction"}]}]},{"version":"v1","default":false,"pages":[{"title":"v1","href":"/api-reference/verifications/cancel-verification"}]}]},"basePath":"","title":"Cancel Verification - hConnect","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}