{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hanko","description":"Documentation for Hanko’s open-source authentication products. Build secure authentication with passkeys, passwords, MFA, social login, SSO, and push authentication.","colors":{"primary":"#6575FF","light":"#6575FF","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/hanko/cvvCniGfSDqJRest/logo/light.svg?fit=max\u0026auto=format\u0026n=cvvCniGfSDqJRest\u0026q=85\u0026s=c11abcf43f80ac4a882d948d9a697da6","dark":"https://mintcdn.com/hanko/cvvCniGfSDqJRest/logo/dark.svg?fit=max\u0026auto=format\u0026n=cvvCniGfSDqJRest\u0026q=85\u0026s=2cbd45a5f965459329fa577fe505b871"},"favicon":"https://mintcdn.com/hanko/nDll7gWf2olRVk-k/favicon.png?fit=max\u0026auto=format\u0026n=nDll7gWf2olRVk-k\u0026q=85\u0026s=0220747b414c9c1af17f71869d87269a","api":{"playground":{"display":"interactive"}},"background":{"image":"https://mintcdn.com/hanko/nDll7gWf2olRVk-k/images/background.png?fit=max\u0026auto=format\u0026n=nDll7gWf2olRVk-k\u0026q=85\u0026s=cb6d5948c52e06bab12e957123881b4b","decoration":"gradient","color":{"dark":"#000000"}},"navbar":{"links":[{"href":"https://discord.gg/tAG6RrRqJD","label":"Discord"}],"primary":{"type":"button","label":"Hanko Cloud Console","href":"https://cloud.hanko.io"}},"footer":{"socials":{"x":"https://x.com/hanko_io","github":"https://github.com/teamhanko","linkedin":"https://www.linkedin.com/company/teamhanko"}},"fonts":{"family":"Geist"},"icons":{"library":"fontawesome"},"integrations":{"plausible":{"domain":"docs.hanko.io"}},"errors":{"404":{"redirect":false}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"thumbnails":{"fonts":{"family":"Geist"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hanko","hasAudioNarration":false,"actualSubdomain":"hanko","customDomains":["docs.hanko.io"],"gitSource":{"type":"github","owner":"teamhanko","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae130142e7b9f2a4eb1451d","collectionId":"e51a69b0-9d1a-4cbb-828c-c20cc6c4b68c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae130142e7b9f2a4eb1451d"},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{},"buildId":"6ae130142e7b9f2a4eb1451d","clientVersion":"0.0.4021","searchFilterCounts":[{"language":"default","tag":"Hanko Docs","count":127},{"language":"default","tag":"Resources","count":68},{"language":"default","tag":"API reference","count":64},{"language":"default","tag":"Admin","count":49},{"language":"default","tag":"Guides","count":41},{"language":"default","tag":"Hanko Authenticator Docs","count":28},{"language":"default","tag":"Getting started","count":27},{"language":"default","tag":"Quickstarts","count":26},{"language":"default","tag":"Passkey API Docs","count":24},{"language":"default","tag":"API Reference","count":22}]},"assistantConfig":{"deflection":{"enabled":true,"email":"support@hanko.io"}},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"hanko-authenticator/reference/create-a-request","slug":"/hanko-authenticator/reference/create-a-request","pageMetadata":{"openapi":"openapi-authenticator post /v1/uaf/requests","description":"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.","title":"Create a request for the Hanko Authenticator","href":"/hanko-authenticator/reference/create-a-request"},"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: \"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[`Remember the returned `,_jsx(_components.code,{children:`id`}),` — you’ll need it to check the status of, validate, or cancel this operation.`]})})}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":{"openapi":"openapi-authenticator post /v1/uaf/requests","description":"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.","title":"Create a request for the Hanko Authenticator","href":"/hanko-authenticator/reference/create-a-request"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a request for the Hanko Authenticator","requestBody":"4d8e45c3-d311-4252-a179-d521698cf957","operationId":"createUaf","description":"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.","responses":{"200":"8deca188-7701-4908-9d4a-fabae6c25127","400":"a15ec6c6-7ae6-4403-8acf-f622e979b719","401":"14ba3c1d-26b5-45af-a520-659e210fe72c","500":"84b5beee-54c9-4484-bc4a-bd2a5fc714e0"},"tags":["Hanko Authenticator"],"method":"post","type":"path","servers":["b101309d-1085-45fb-a452-e9b483f7e10c"],"security":["24dc1bbb-0e4a-4193-a5b7-868d1be299ac"],"path":"/v1/uaf/requests","baseUrlOptions":["https://{your_hanko_authenticator_instance}"],"title":"Create a request for the Hanko Authenticator","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"description":"The description","required":true,"content":{"application/json":{"schema":{"properties":{"operation":{"type":"string","enum":["AUTH","DEREG","REG"],"isRequired":true,"uniqueKey":"operation","typeLabel":"enum\u003cstring>"},"username":{"type":"string","uniqueKey":"username","typeLabel":"string"},"userId":{"type":"string","uniqueKey":"userId","typeLabel":"string"},"displayName":{"type":"string","uniqueKey":"displayName","typeLabel":"string"},"clientData":{"properties":{"remoteAddress":{"type":"string","uniqueKey":"clientData.remoteAddress","typeLabel":"string"},"userAgent":{"type":"string","uniqueKey":"clientData.userAgent","typeLabel":"string"}},"type":"object","uniqueKey":"clientData","typeLabel":"object"},"transaction":{"type":"string","uniqueKey":"transaction","typeLabel":"string"},"deviceIds":{"type":"array","items":{"type":"string","uniqueKey":"deviceIds.items.[INDEX]","typeLabel":"string"},"uniqueKey":"deviceIds","typeLabel":"string[]"},"authenticatorSelectionCriteria":{"properties":{"authenticatorAttachment":{"type":"string","enum":["platform","cross-platform"],"uniqueKey":"authenticatorSelectionCriteria.authenticatorAttachment","typeLabel":"enum\u003cstring>"},"requireResidentKey":{"type":"boolean","uniqueKey":"authenticatorSelectionCriteria.requireResidentKey","typeLabel":"boolean"},"userVerification":{"type":"string","enum":["required","preferred","discouraged"],"uniqueKey":"authenticatorSelectionCriteria.userVerification","typeLabel":"enum\u003cstring>"}},"type":"object","uniqueKey":"authenticatorSelectionCriteria","typeLabel":"object"},"attestationConveyancePreference":{"type":"string","enum":["direct","indirect","none"],"uniqueKey":"attestationConveyancePreference","typeLabel":"enum\u003cstring>"},"isSecondFactorOnly":{"type":"boolean","uniqueKey":"isSecondFactorOnly","typeLabel":"boolean"}},"required":["operation"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"username":"\u003cstring>","userId":"\u003cstring>","displayName":"\u003cstring>","clientData":{"remoteAddress":"\u003cstring>","userAgent":"\u003cstring>"},"transaction":"\u003cstring>","deviceIds":["\u003cstring>"],"authenticatorSelectionCriteria":{"requireResidentKey":true},"isSecondFactorOnly":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8deca188-7701-4908-9d4a-fabae6c25127":{"description":"The full Hanko request for an initialized authentication operation including links","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"operation":{"type":"string","enum":["AUTH","DEREG","REG"],"isRequired":true,"uniqueKey":"operation","typeLabel":"enum\u003cstring>"},"username":{"type":"string","isRequired":true,"uniqueKey":"username","typeLabel":"string"},"userId":{"type":"string","isRequired":true,"uniqueKey":"userId","typeLabel":"string"},"status":{"type":"string","enum":["PENDING","OK","FAILED","INVALIDATED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"createdAt":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"validUntil":{"format":"date-time","type":"string","isRequired":true,"uniqueKey":"validUntil","typeLabel":"string\u003cdate-time>"},"relyingParty":{"properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"relyingParty.id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"relyingParty.name","typeLabel":"string"},"appId":{"type":"string","isRequired":true,"uniqueKey":"relyingParty.appId","typeLabel":"string"},"icon":{"type":"string","isRequired":true,"uniqueKey":"relyingParty.icon","typeLabel":"string"}},"required":["id","name","appId","icon"],"type":"object","isRequired":true,"uniqueKey":"relyingParty","typeLabel":"object"},"links":{"type":"array","items":{"properties":{"rel":{"type":"string","isRequired":true,"uniqueKey":"links.items.[INDEX].rel","typeLabel":"string"},"method":{"type":"string","isRequired":true,"uniqueKey":"links.items.[INDEX].method","typeLabel":"string"},"href":{"type":"string","isRequired":true,"uniqueKey":"links.items.[INDEX].href","typeLabel":"string"}},"required":["rel","method","href"],"type":"object","uniqueKey":"links.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"links","typeLabel":"object[]"},"request":{"type":"string","isRequired":true,"uniqueKey":"request","typeLabel":"string"},"deviceID":{"type":"string","isRequired":true,"uniqueKey":"deviceID","typeLabel":"string"},"clientData":{"properties":{"remoteAddress":{"type":"string","uniqueKey":"clientData.remoteAddress","typeLabel":"string"},"userAgent":{"type":"string","uniqueKey":"clientData.userAgent","typeLabel":"string"}},"type":"object","uniqueKey":"clientData","typeLabel":"object"},"location":{"properties":{"country":{"type":"string","isRequired":true,"uniqueKey":"location.country","typeLabel":"string"},"region":{"type":"string","isRequired":true,"uniqueKey":"location.region","typeLabel":"string"},"city":{"type":"string","isRequired":true,"uniqueKey":"location.city","typeLabel":"string"}},"required":["country","region","city"],"type":"object","uniqueKey":"location","typeLabel":"object"},"transaction":{"type":"string","uniqueKey":"transaction","typeLabel":"string"},"device":{"properties":{"deviceId":{"type":"string","uniqueKey":"device.deviceId","typeLabel":"string"},"keyName":{"type":"string","uniqueKey":"device.keyName","typeLabel":"string"}},"type":"object","uniqueKey":"device","typeLabel":"object"},"isSecondFactorOnly":{"type":"boolean","uniqueKey":"isSecondFactorOnly","typeLabel":"boolean"},"error":{"properties":{"code":{"type":"integer","format":"int32","isRequired":true,"uniqueKey":"error.code","typeLabel":"integer\u003cint32>"},"reason":{"type":"string","uniqueKey":"error.reason","typeLabel":"string"}},"required":["code"],"type":"object","uniqueKey":"error","typeLabel":"object"}},"required":["id","operation","username","userId","status","createdAt","validUntil","relyingParty","links","request","deviceID"],"type":"object","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","operation":"AUTH","username":"\u003cstring>","userId":"\u003cstring>","status":"PENDING","createdAt":"2023-11-07T05:31:56Z","validUntil":"2023-11-07T05:31:56Z","relyingParty":{"id":"\u003cstring>","name":"\u003cstring>","appId":"\u003cstring>","icon":"\u003cstring>"},"links":[{"rel":"\u003cstring>","method":"\u003cstring>","href":"\u003cstring>"}],"request":"\u003cstring>","deviceID":"\u003cstring>","clientData":{"remoteAddress":"\u003cstring>","userAgent":"\u003cstring>"},"location":{"country":"\u003cstring>","region":"\u003cstring>","city":"\u003cstring>"},"transaction":"\u003cstring>","device":{"deviceId":"\u003cstring>","keyName":"\u003cstring>"},"isSecondFactorOnly":true,"error":{"code":123,"reason":"\u003cstring>"}}}},"exampleType":"generated"}},"links":{"Validate":{"$ref":"#/components/links/Validate"},"Get":{"$ref":"#/components/links/Get"},"Cancel":{"$ref":"#/components/links/Cancel"},"QrCode":{"$ref":"#/components/links/QrCode"}},"exampleType":"generated"},"a15ec6c6-7ae6-4403-8acf-f622e979b719":{"description":"Bad request, the service could not process your request.","content":{"application/json":{"schema":{"type":"object","description":"An error object giving details about the origin of the error","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":400,"message":"Bad Request"},"examples":{"Example":{"title":"Example","value":{"code":400,"message":"Bad Request"}}},"exampleType":"examples"}},"exampleType":"examples"},"14ba3c1d-26b5-45af-a520-659e210fe72c":{"description":"You are not authenticated. Provide your credentials.","content":{"application/json":{"schema":{"type":"object","description":"An error object giving details about the origin of the error","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":401,"message":"Unauthorized"},"examples":{"Example":{"title":"Example","value":{"code":401,"message":"Unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"84b5beee-54c9-4484-bc4a-bd2a5fc714e0":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"type":"object","description":"An error object giving details about the origin of the error","properties":{"code":{"type":"integer","uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"code":500,"message":"Internal Server Error"},"examples":{"Example":{"title":"Example","value":{"code":500,"message":"Internal Server Error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"24dc1bbb-0e4a-4193-a5b7-868d1be299ac":{"ApiKeyAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"This API uses `Authorization: secret \u003capi_key>`\nrather than the standard `Bearer` scheme.\n","scopes":[]}}},"servers":{"b101309d-1085-45fb-a452-e9b483f7e10c":{"url":"https://{your_hanko_authenticator_instance}","description":"The Hanko Authenticator API is currently offered as a test instance and is not provisioned through the Hanko Cloud Console. Contact us at info@hanko.io for test access and your instance URL. Most customers self-host this API.","variables":{"your_hanko_authenticator_instance":{"default":"your-test-instance.example.com","description":"The host of your Hanko Authenticator API test instance or self-hosted deployment."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"API Key","description":"This API uses `Authorization: secret \u003capi_key>`\nrather than the standard `Bearer` scheme.\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"This API uses `Authorization: secret \u003capi_key>`\nrather than the standard `Bearer` scheme.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi-authenticator.yaml"},"subdomain":"hanko","siteName":"Hanko","title":"Create a request for the Hanko Authenticator - Hanko","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-20T19:06:30.210Z","originalFileLocation":"hanko-authenticator/reference/create-a-request.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=\"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hanko\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_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/hanko/E70FYFIuCUxDugor/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a request for the Hanko Authenticator - Hanko\">\u003cmeta data-mint-head property=\"og:description\" content=\"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hanko\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hanko.mintlify.app/_mintlify/api/og/v2?division=Hanko+Authenticator\u0026amp;title=Create+a+request+for+the+Hanko+Authenticator\u0026amp;description=Initialize+a+registration%2C+authentication%2C+or+de-registration+operation+for+the+Hanko+Authenticator.\u0026amp;theme=0019bde39b8e96d0b6d738b4\u0026amp;signature=446d2f755adc35a4f5bb8fda71a462a4f95322777c7b05a07fa0035b50d69637\">\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 a request for the Hanko Authenticator - Hanko\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hanko.mintlify.app/_mintlify/api/og/v2?division=Hanko+Authenticator\u0026amp;title=Create+a+request+for+the+Hanko+Authenticator\u0026amp;description=Initialize+a+registration%2C+authentication%2C+or+de-registration+operation+for+the+Hanko+Authenticator.\u0026amp;theme=0019bde39b8e96d0b6d738b4\u0026amp;signature=446d2f755adc35a4f5bb8fda71a462a4f95322777c7b05a07fa0035b50d69637\">\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/hanko/E70FYFIuCUxDugor/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hanko\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6575FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/hanko-authenticator/reference/create-a-request.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hanko.io/#organization\",\"name\":\"Hanko\",\"url\":\"https://docs.hanko.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hanko/cvvCniGfSDqJRest/logo/light.svg?fit=max\u0026auto=format\u0026n=cvvCniGfSDqJRest\u0026q=85\u0026s=c11abcf43f80ac4a882d948d9a697da6\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hanko.io#website\",\"name\":\"Hanko\",\"url\":\"https://docs.hanko.io\",\"publisher\":{\"@id\":\"https://docs.hanko.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request#webpage\",\"url\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request\",\"name\":\"Create a request for the Hanko Authenticator\",\"description\":\"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.\",\"dateModified\":\"2026-07-20T19:06:30.210Z\",\"isPartOf\":{\"@id\":\"https://docs.hanko.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Hanko\",\"item\":\"https://docs.hanko.io\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a request for the Hanko Authenticator\",\"item\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request#apireference\",\"headline\":\"Create a request for the Hanko Authenticator\",\"name\":\"Create a request for the Hanko Authenticator\",\"description\":\"Initialize a registration, authentication, or de-registration operation for the Hanko Authenticator.\",\"url\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hanko.io/hanko-authenticator/reference/create-a-request#webpage\"},\"dateModified\":\"2026-07-20T19:06:30.210Z\",\"publisher\":{\"@id\":\"https://docs.hanko.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hanko.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hanko\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hanko","nav":{"global":null,"tabs":[{"tab":"Hanko Docs","pages":[{"title":"Hanko Docs","href":"/introduction"}]},{"tab":"Passkey API Docs","pages":[{"title":"Passkey API Docs","href":"/passkey-api/introduction"}]},{"tab":"Hanko Authenticator Docs","groups":[{"group":"Getting started","pages":[{"sidebarTitle":"Introduction","title":"Introduction to Hanko Authenticator","mode":"wide","href":"/hanko-authenticator/introduction"},{"sidebarTitle":"Core components","title":"Core components","href":"/hanko-authenticator/core-components"},{"sidebarTitle":"What is FIDO UAF?","title":"What is FIDO UAF?","href":"/hanko-authenticator/what-is-fido-uaf"}]},{"group":"Quickstarts","pages":[{"group":"Hanko Authenticator App","pages":[{"sidebarTitle":"Overview","title":"Getting started with Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app"},{"sidebarTitle":"Registration","title":"Register a device using the Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app-registration"},{"sidebarTitle":"Authentication","title":"Authenticate with a device using Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app-authentication"},{"sidebarTitle":"Transactions","title":"Confirm transactions using Hanko Authenticator","href":"/hanko-authenticator/quickstart/authenticator-app-transactions"},{"sidebarTitle":"De-registration","title":"De-register a device","href":"/hanko-authenticator/quickstart/authenticator-app-de-registration"}]},{"group":"FIDO UAF Client SDK","pages":[{"sidebarTitle":"Overview","title":"Getting started with the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client"},{"sidebarTitle":"Registration","title":"Register a device with the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-registration"},{"sidebarTitle":"Authentication","title":"Authenticate with a device using the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-authentication"},{"sidebarTitle":"Transactions","title":"Confirm transactions using the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-transactions"},{"sidebarTitle":"De-registration","title":"De-register a device using the Hanko FIDO UAF Client","href":"/hanko-authenticator/quickstart/uaf-client-de-registration"}]}]},{"group":"Guides","pages":[{"sidebarTitle":"Integration overview","title":"Integration guide","href":"/hanko-authenticator/guides/integration-overview"},{"sidebarTitle":"Registration screen","title":"Modifying your registration flow","href":"/hanko-authenticator/guides/registration-screen"},{"sidebarTitle":"Login screen","title":"Modifying your login flow","href":"/hanko-authenticator/guides/login-screen"},{"sidebarTitle":"Recovery","title":"Recovery techniques","href":"/hanko-authenticator/guides/recovery"},{"sidebarTitle":"Authenticator apps","title":"Hanko Authenticator apps","href":"/hanko-authenticator/guides/authenticator-apps"}]},{"group":"SDKs \u0026 Plugins","pages":[{"sidebarTitle":"Android","title":"FIDO UAF Client for Android","href":"/hanko-authenticator/sdks/android"},{"sidebarTitle":"iOS","title":"FIDO UAF Client for iOS","href":"/hanko-authenticator/sdks/ios"},{"sidebarTitle":"Keycloak plugin","title":"Hanko Keycloak plugin","description":"Integrate the Hanko Authenticator into Keycloak as a login option.","href":"/hanko-authenticator/sdks/keycloak-plugin"}]},{"group":"API Reference","pages":[{"group":"Hanko Authenticator","pages":[{"openapi":"openapi-authenticator post /v1/uaf/requests","title":"Create a request for the Hanko Authenticator","href":"/hanko-authenticator/reference/create-a-request"},{"openapi":"openapi-authenticator get /v1/uaf/requests/{id}","description":"Get the current status of a previously created Hanko Authenticator operation.","title":"Get the request for the Hanko Authenticator","href":"/hanko-authenticator/reference/get-a-request"},{"openapi":"openapi-authenticator delete /v1/uaf/requests/{id}","title":"Cancel the request for the Hanko Authenticator","href":"/hanko-authenticator/reference/cancel-a-request"},{"openapi":"openapi-authenticator put /v1/uaf/requests/{id}","title":"Validate the request as retrieved from the Hanko Authenticator","href":"/hanko-authenticator/reference/validate-a-request"},{"openapi":"openapi-authenticator get /v1/uaf/requests/{id}/qrcode","title":"Get the QR code for a given Hanko Authenticator request","href":"/hanko-authenticator/reference/get-a-qr-code"}]},{"group":"Device Management","pages":[{"openapi":"openapi-authenticator get /mgmt/v1/registrations/{userId}","title":"Get all devices of a user","href":"/hanko-authenticator/reference/get-a-users-devices"},{"openapi":"openapi-authenticator post /mgmt/v1/registrations/rename/{deviceId}","title":"Change the name of a authentication device","href":"/hanko-authenticator/reference/rename-a-device"}]}]}]}]},"title":"Create a request for the Hanko Authenticator - Hanko","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}