Before using the Useawards SDK, you need to authorize the user to access your Useawards account. You can do this by generating an API key in your Useawards account dashboard and providing it to your application.To generate an API key, log in to your Useawards account and go to the “API Keys” section in the dashboard. Create a new API key and copy the key value.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Documentation Starter Kit","colors":{"primary":"#0069ED","light":"#4D9CFF","dark":"#0050B4"},"favicon":"/favicon.png","logo":{"light":"https://mintcdn.com/useaward/F5tYMcn_RFwjA7ju/logo/light.png?fit=max\u0026auto=format\u0026n=F5tYMcn_RFwjA7ju\u0026q=85\u0026s=5d902bd5cf6e4111b3ca3cff706138e8","dark":"https://mintcdn.com/useaward/F5tYMcn_RFwjA7ju/logo/dark.png?fit=max\u0026auto=format\u0026n=F5tYMcn_RFwjA7ju\u0026q=85\u0026s=fdd5b076b977e5a6d4edc9b5636a9e7d"},"navbar":{"links":[{"label":"Documentation","href":"https://useaward.mintlify.app/introduction"}],"primary":{"type":"button","label":"Get Started","href":"https://useaward.mintlify.app/introduction"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"useaward","hasAudioNarration":false,"actualSubdomain":"useaward","customDomains":[],"gitSource":{"type":"github","owner":"reinisl","repo":"useawards-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91521490ed5cbb56078c6:success","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Frameworks","count":9},{"language":"default","tag":"Hooks","count":7},{"language":"default","tag":"Expo","count":5},{"language":"default","tag":"React","count":4},{"language":"default","tag":"Getting Started","count":1},{"language":"default","tag":"Home","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"getting-started/authorization","slug":"/getting-started/authorization","pageMetadata":{"title":"Authorization","description":null,"href":"/getting-started/authorization"},"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={p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`authorization`,children:`Authorization`}),`\n`,_jsx(_components.p,{children:`Before using the Useawards SDK, you need to authorize the user to access your Useawards account. You can do this by generating an API key in your Useawards account dashboard and providing it to your application.`}),`\n`,_jsx(_components.p,{children:`To generate an API key, log in to your Useawards account and go to the “API Keys” section in the dashboard. Create a new API key and copy the key value.`})]})}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":"Authorization","description":null,"href":"/getting-started/authorization"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Authorization","slug":"authorization","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"useaward","siteName":"Documentation Starter Kit","title":"Authorization - Documentation Starter Kit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:49:34.095Z","originalFileLocation":"getting-started/authorization.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=\"application-name\" content=\"Documentation Starter Kit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/useaward/xi4yjT9NoxxX-JkJ/_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/useaward/xi4yjT9NoxxX-JkJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/useaward/xi4yjT9NoxxX-JkJ/_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/useaward/xi4yjT9NoxxX-JkJ/_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/useaward/xi4yjT9NoxxX-JkJ/_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/useaward/xi4yjT9NoxxX-JkJ/_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/useaward/xi4yjT9NoxxX-JkJ/_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/useaward/xi4yjT9NoxxX-JkJ/_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/useaward/xi4yjT9NoxxX-JkJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Authorization - Documentation Starter Kit\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Documentation Starter Kit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://useaward.mintlify.app/getting-started/authorization\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://useaward.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Authorization\u0026amp;theme=fe3365185856eae099f025ad\u0026amp;signature=7af88c55ab890de1344be397f00790499f2d0a308cb1e6948d32f0e726df1011\">\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=\"Authorization - Documentation Starter Kit\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://useaward.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Authorization\u0026amp;theme=fe3365185856eae099f025ad\u0026amp;signature=7af88c55ab890de1344be397f00790499f2d0a308cb1e6948d32f0e726df1011\">\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/useaward/xi4yjT9NoxxX-JkJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Documentation Starter Kit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0069ED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://useaward.mintlify.app/getting-started/authorization\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/getting-started/authorization.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://useaward.mintlify.app/#organization\",\"name\":\"Documentation Starter Kit\",\"url\":\"https://useaward.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/useaward/F5tYMcn_RFwjA7ju/logo/light.png?fit=max\u0026auto=format\u0026n=F5tYMcn_RFwjA7ju\u0026q=85\u0026s=5d902bd5cf6e4111b3ca3cff706138e8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://useaward.mintlify.app#website\",\"name\":\"Documentation Starter Kit\",\"url\":\"https://useaward.mintlify.app\",\"publisher\":{\"@id\":\"https://useaward.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://useaward.mintlify.app/getting-started/authorization#webpage\",\"url\":\"https://useaward.mintlify.app/getting-started/authorization\",\"name\":\"Authorization\",\"dateModified\":\"2026-01-06T22:49:34.095Z\",\"isPartOf\":{\"@id\":\"https://useaward.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://useaward.mintlify.app/getting-started/authorization#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://useaward.mintlify.app/getting-started/authorization#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documentation Starter Kit\",\"item\":\"https://useaward.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Authorization\",\"item\":\"https://useaward.mintlify.app/getting-started/authorization\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://useaward.mintlify.app/getting-started/authorization#article\",\"headline\":\"Authorization\",\"name\":\"Authorization\",\"url\":\"https://useaward.mintlify.app/getting-started/authorization\",\"mainEntityOfPage\":{\"@id\":\"https://useaward.mintlify.app/getting-started/authorization#webpage\"},\"dateModified\":\"2026-01-06T22:49:34.095Z\",\"publisher\":{\"@id\":\"https://useaward.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://useaward.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Documentation Starter Kit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Documentation Starter Kit","nav":{"global":null,"groups":[{"group":"Home","pages":[{"title":"Introduction","description":"Welcome to Useawards documentation.","href":"/introduction"}]},{"group":"Getting Started","pages":[{"title":"Authorization","href":"/getting-started/authorization"}]},{"group":"Frameworks","pages":[{"group":"React","pages":[{"title":"Usage","description":"Description about how to use with React framework","href":"/getting-started/react/usage"},{"group":"Hooks","pages":[{"title":"useUserAuthorize","href":"/getting-started/react/hooks/useUserAuthorize"},{"title":"useUser","href":"/getting-started/react/hooks/useUser"},{"title":"useFetchPrizes","href":"/getting-started/react/hooks/useFetchPrizes"}]}]},{"group":"Expo","pages":[{"title":"Usage","href":"/getting-started/expo/usage"},{"group":"Hooks","pages":[{"title":"useUser","href":"/getting-started/expo/hooks/useUser"},{"title":"usePrize","href":"/getting-started/expo/hooks/usePrizes"},{"title":"useOrder","href":"/getting-started/expo/hooks/useOrder"},{"title":"usePoints","href":"/getting-started/expo/hooks/usePoints"}]}]}]}]},"basePath":"","title":"Authorization - Documentation Starter Kit","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":[],"chunks":[]}
