[{"data":1,"prerenderedAt":4589},["ShallowReactive",2],{"navLinks":3,"sidebar_docs_navigation_\u002Fdocs\u002Fiam":64,"navigation":257,"navLinks_footer":837,"\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fverification_page":850,"\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fverification_surround":2932,"\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fverification":2935},{"id":4,"extension":5,"links":6,"meta":61,"stem":62,"__hash__":63},"navigationMenu\u002Fnavigation.json","json",[7,52,57],{"nested":8,"label":9,"icon":10,"to":11,"children":12},true,"Docs","i-lucide-book-open","\u002Fdocs\u002Fgetting-started",[13,19,26,32,39,45],{"label":14,"icon":15,"to":11,"description":16,"github":17,"badge":18},"Getting Started","i-lucide-rocket","An introduction to help you understand the core components.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fdocshub","Start Here",{"label":20,"icon":21,"to":22,"description":23,"github":24,"badge":25},"Auth H3 Client","i-lucide-key-round","\u002Fdocs\u002Fauth-h3client","Seamlessly enforce OAuth 2.0 authentication and session management integrated directly as the client of the IAM module.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fauth-h3client","Core",{"label":27,"icon":28,"to":29,"description":30,"github":31,"badge":25},"IAM","i-lucide-shield-check","\u002Fdocs\u002Fiam","Identity and Access Management featuring granular roles, permissions, and security policies.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fauth",{"label":33,"icon":34,"to":35,"description":36,"github":37,"badge":38},"Bot Detection","i-lucide-cpu","\u002Fdocs\u002Fbot-detection","Advanced behavioral analysis and request fingerprinting to stop malicious automated traffic.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fbot-detector","Security",{"label":40,"icon":41,"to":42,"description":43,"github":44,"badge":38},"Shield Base","i-lucide-database-zap","\u002Fdocs\u002Fshield-base","CLI and programmatic toolkit for compiling offline-ready IP intelligence databases from BGP, GeoIP, Tor, FireHOL, and other public threat feeds.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Fshield-base-cli",{"label":46,"icon":47,"to":48,"description":49,"github":50,"badge":51},"Utils","i-lucide-wrench","\u002Fdocs\u002Futils","A standard library of highly optimized helpers for formatting, validation, and core logic.","https:\u002F\u002Fgithub.com\u002FSergo706\u002Futils","Library",{"nested":53,"label":54,"icon":55,"to":56},false,"Blog","i-lucide-pen-line","\u002Fblog",{"nested":53,"label":58,"icon":59,"to":60},"Website","lucide:app-window-mac","https:\u002F\u002Friavzon.com",{},"navigation","gkaQ0xRGxSLrLyM3kttLe0oBwkrR1EBjlepF8LSbwF8",[65],{"title":9,"path":66,"stem":67,"children":68,"page":53},"\u002Fdocs","docs",[69],{"title":27,"path":29,"stem":70,"children":71},"docs\u002Fiam\u002Findex",[72,73,76,216,219,236,240],{"title":27,"path":29,"stem":70},{"title":14,"path":74,"stem":75},"\u002Fdocs\u002Fiam\u002Fgetting-started","docs\u002Fiam\u002F00.getting-started",{"title":77,"path":78,"stem":79,"children":80},"Essentials","\u002Fdocs\u002Fiam\u002Fessentials","docs\u002Fiam\u002F01.essentials\u002Findex",[81,82,86,90,94,98,102,106,110,114,118,122,126,130,134,138,142,146,150,154,158,162,166],{"title":77,"path":78,"stem":79},{"title":83,"path":84,"stem":85},"Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Ftokens","docs\u002Fiam\u002F01.essentials\u002F00.tokens",{"title":87,"path":88,"stem":89},"Access Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Faccess-tokens","docs\u002Fiam\u002F01.essentials\u002F01.access-tokens",{"title":91,"path":92,"stem":93},"Refresh Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Frefresh-tokens","docs\u002Fiam\u002F01.essentials\u002F02.refresh-tokens",{"title":95,"path":96,"stem":97},"Anomaly Detection","\u002Fdocs\u002Fiam\u002Fessentials\u002Fanomalies","docs\u002Fiam\u002F01.essentials\u002F03.anomalies",{"title":99,"path":100,"stem":101},"Signup","\u002Fdocs\u002Fiam\u002Fessentials\u002Fsignup","docs\u002Fiam\u002F01.essentials\u002F04.signup",{"title":103,"path":104,"stem":105},"Login","\u002Fdocs\u002Fiam\u002Fessentials\u002Flogin","docs\u002Fiam\u002F01.essentials\u002F05.login",{"title":107,"path":108,"stem":109},"Logout","\u002Fdocs\u002Fiam\u002Fessentials\u002Flogout","docs\u002Fiam\u002F01.essentials\u002F06.logout",{"title":111,"path":112,"stem":113},"OAuth","\u002Fdocs\u002Fiam\u002Fessentials\u002Foauth","docs\u002Fiam\u002F01.essentials\u002F07.oauth",{"title":115,"path":116,"stem":117},"Magic Links","\u002Fdocs\u002Fiam\u002Fessentials\u002Fmagic-links","docs\u002Fiam\u002F01.essentials\u002F08.magic-links",{"title":119,"path":120,"stem":121},"Emails","\u002Fdocs\u002Fiam\u002Fessentials\u002Femails","docs\u002Fiam\u002F01.essentials\u002F09.emails",{"title":123,"path":124,"stem":125},"MFA","\u002Fdocs\u002Fiam\u002Fessentials\u002Fmfa","docs\u002Fiam\u002F01.essentials\u002F10.mfa",{"title":127,"path":128,"stem":129},"Fingerprinting","\u002Fdocs\u002Fiam\u002Fessentials\u002Ffingerprinting","docs\u002Fiam\u002F01.essentials\u002F11.fingerprinting",{"title":131,"path":132,"stem":133},"Backend for Frontend","\u002Fdocs\u002Fiam\u002Fessentials\u002Fbff","docs\u002Fiam\u002F01.essentials\u002F12.bff",{"title":135,"path":136,"stem":137},"HMAC Authentication","\u002Fdocs\u002Fiam\u002Fessentials\u002Fhmac","docs\u002Fiam\u002F01.essentials\u002F13.hmac",{"title":139,"path":140,"stem":141},"XSS Protection","\u002Fdocs\u002Fiam\u002Fessentials\u002Fxss","docs\u002Fiam\u002F01.essentials\u002F14.xss",{"title":143,"path":144,"stem":145},"Logging","\u002Fdocs\u002Fiam\u002Fessentials\u002Flogging","docs\u002Fiam\u002F01.essentials\u002F15.logging",{"title":147,"path":148,"stem":149},"Rate Limiting","\u002Fdocs\u002Fiam\u002Fessentials\u002Frate-limiting","docs\u002Fiam\u002F01.essentials\u002F16.rate-limiting",{"title":151,"path":152,"stem":153},"Database","\u002Fdocs\u002Fiam\u002Fessentials\u002Fdatabase","docs\u002Fiam\u002F01.essentials\u002F17.database",{"title":155,"path":156,"stem":157},"Cookies","\u002Fdocs\u002Fiam\u002Fessentials\u002Fcookies","docs\u002Fiam\u002F01.essentials\u002F18.cookies",{"title":159,"path":160,"stem":161},"Service Startup","\u002Fdocs\u002Fiam\u002Fessentials\u002Fservice","docs\u002Fiam\u002F01.essentials\u002F19.service",{"title":163,"path":164,"stem":165},"Password Reset","\u002Fdocs\u002Fiam\u002Fessentials\u002Fpassword-reset","docs\u002Fiam\u002F01.essentials\u002F20.password-reset",{"title":167,"path":168,"stem":169,"children":170},"API Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi","docs\u002Fiam\u002F01.essentials\u002F21.api\u002Findex",[171,172,176,180,210,213],{"title":167,"path":168,"stem":169},{"title":173,"path":174,"stem":175},"Creating Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fcreation","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F00.creation",{"title":177,"path":178,"stem":179},"Verifying Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fverification","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F01.verification",{"title":181,"path":182,"stem":183,"children":184},"Manage Tokens","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002Findex",[185,186,190,194,198,202,206],{"title":181,"path":182,"stem":183},{"title":187,"path":188,"stem":189},"Privileges","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Fprivilege","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F00.privilege",{"title":191,"path":192,"stem":193},"Revocation","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Frevocation","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F01.revocation",{"title":195,"path":196,"stem":197},"Rotation","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Frotation","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F02.rotation",{"title":199,"path":200,"stem":201},"IP Restriction","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Fip-updates","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F03.ip-updates",{"title":203,"path":204,"stem":205},"Metadata","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Fmetadata","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F04.metadata",{"title":207,"path":208,"stem":209},"Token Listing","\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fmanagement\u002Flist","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F02.management\u002F05.list",{"title":147,"path":211,"stem":212},"\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Frate-limiting","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F03.rate-limiting",{"title":38,"path":214,"stem":215},"\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fsecurity","docs\u002Fiam\u002F01.essentials\u002F21.api\u002F04.security",{"title":38,"path":217,"stem":218},"\u002Fdocs\u002Fiam\u002Fsecurity","docs\u002Fiam\u002F02.security",{"title":220,"path":221,"stem":222,"children":223,"page":53},"Guides","\u002Fdocs\u002Fiam\u002Fguides","docs\u002Fiam\u002F03.guides",[224,228,232],{"title":225,"path":226,"stem":227},"Deployment","\u002Fdocs\u002Fiam\u002Fguides\u002Fdeployment","docs\u002Fiam\u002F03.guides\u002Fdeployment",{"title":229,"path":230,"stem":231},"Operation Scripts","\u002Fdocs\u002Fiam\u002Fguides\u002Foperation-scripts","docs\u002Fiam\u002F03.guides\u002Foperation-scripts",{"title":233,"path":234,"stem":235},"Role-Based Access Control","\u002Fdocs\u002Fiam\u002Fguides\u002Frbac","docs\u002Fiam\u002F03.guides\u002Frbac",{"title":237,"path":238,"stem":239},"Configuration","\u002Fdocs\u002Fiam\u002Fconfiguration","docs\u002Fiam\u002F04.configuration",{"title":241,"path":242,"stem":243,"children":244,"page":53},"Api","\u002Fdocs\u002Fiam\u002Fapi","docs\u002Fiam\u002F05.API",[245,249,253],{"title":246,"path":247,"stem":248},"API Reference","\u002Fdocs\u002Fiam\u002Fapi\u002Fapi","docs\u002Fiam\u002F05.API\u002F00.api",{"title":250,"path":251,"stem":252},"Middleware Reference","\u002Fdocs\u002Fiam\u002Fapi\u002Fmiddlewares","docs\u002Fiam\u002F05.API\u002F02.middlewares",{"title":254,"path":255,"stem":256},"Routes Reference","\u002Fdocs\u002Fiam\u002Fapi\u002Froutes","docs\u002Fiam\u002F05.API\u002F03.routes",[258],{"title":9,"path":66,"stem":67,"children":259,"page":53},[260,398,516,521,577,644],{"title":20,"path":22,"stem":261,"children":262},"docs\u002Fauth-h3client\u002Findex",[263,264,273,307,331,353,356,376,379],{"title":20,"path":22,"stem":261},{"title":14,"path":265,"stem":266,"children":267},"\u002Fdocs\u002Fauth-h3client\u002Fgetting-started","docs\u002Fauth-h3client\u002F00.getting-started\u002Findex",[268,269],{"title":14,"path":265,"stem":266},{"title":270,"path":271,"stem":272},"Nuxt Module","\u002Fdocs\u002Fauth-h3client\u002Fgetting-started\u002Fnuxt","docs\u002Fauth-h3client\u002F00.getting-started\u002F00.nuxt",{"title":77,"path":274,"stem":275,"children":276},"\u002Fdocs\u002Fauth-h3client\u002Fessentials","docs\u002Fauth-h3client\u002F01.essentials\u002Findex",[277,278,282,286,290,294,298,301,304],{"title":77,"path":274,"stem":275},{"title":279,"path":280,"stem":281},"Session Management","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fsession","docs\u002Fauth-h3client\u002F01.essentials\u002F00.session",{"title":283,"path":284,"stem":285},"Route Protection","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Froute-protection","docs\u002Fauth-h3client\u002F01.essentials\u002F01.route-protection",{"title":287,"path":288,"stem":289},"CSRF Protection","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fcsrf","docs\u002Fauth-h3client\u002F01.essentials\u002F02.csrf",{"title":291,"path":292,"stem":293},"Auth Flows","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fauth-flows","docs\u002Fauth-h3client\u002F01.essentials\u002F03.auth-flows",{"title":295,"path":296,"stem":297},"OAuth and OIDC","\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Foauth","docs\u002Fauth-h3client\u002F01.essentials\u002F04.oauth",{"title":33,"path":299,"stem":300},"\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fbot-detection","docs\u002Fauth-h3client\u002F01.essentials\u002F05.bot-detection",{"title":155,"path":302,"stem":303},"\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Fcookies","docs\u002Fauth-h3client\u002F01.essentials\u002F06.cookies",{"title":143,"path":305,"stem":306},"\u002Fdocs\u002Fauth-h3client\u002Fessentials\u002Flogging","docs\u002Fauth-h3client\u002F01.essentials\u002F07.logging",{"title":123,"path":308,"stem":309,"children":310},"\u002Fdocs\u002Fauth-h3client\u002Fmfa","docs\u002Fauth-h3client\u002F02.mfa\u002Findex",[311,312,316,319,323,327],{"title":123,"path":308,"stem":309},{"title":313,"path":314,"stem":315},"Built-in MFA","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fbuilt-in-flow","docs\u002Fauth-h3client\u002F02.mfa\u002F01.built-in-flow",{"title":163,"path":317,"stem":318},"\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fpassword-reset","docs\u002Fauth-h3client\u002F02.mfa\u002F02.password-reset",{"title":320,"path":321,"stem":322},"Email Change","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Femail-change","docs\u002Fauth-h3client\u002F02.mfa\u002F03.email-change",{"title":324,"path":325,"stem":326},"Custom MFA Flow","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fcustom-flow","docs\u002Fauth-h3client\u002F02.mfa\u002F04.custom-flow",{"title":328,"path":329,"stem":330},"Client-Side MFA","\u002Fdocs\u002Fauth-h3client\u002Fmfa\u002Fclient-side","docs\u002Fauth-h3client\u002F02.mfa\u002F05.client-side",{"title":332,"path":333,"stem":334,"children":335},"Client-side","\u002Fdocs\u002Fauth-h3client\u002Fclient","docs\u002Fauth-h3client\u002F03.client\u002Findex",[336,337,341,345,349],{"title":332,"path":333,"stem":334},{"title":338,"path":339,"stem":340},"useAuthData","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fuse-auth-data","docs\u002Fauth-h3client\u002F03.client\u002F00.use-auth-data",{"title":342,"path":343,"stem":344},"useMagicLink","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fuse-magic-link","docs\u002Fauth-h3client\u002F03.client\u002F01.use-magic-link",{"title":346,"path":347,"stem":348},"executeRequest","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fexecute-request","docs\u002Fauth-h3client\u002F03.client\u002F02.execute-request",{"title":350,"path":351,"stem":352},"getCsrfToken","\u002Fdocs\u002Fauth-h3client\u002Fclient\u002Fget-csrf-token","docs\u002Fauth-h3client\u002F03.client\u002F03.get-csrf-token",{"title":38,"path":354,"stem":355},"\u002Fdocs\u002Fauth-h3client\u002Fsecurity","docs\u002Fauth-h3client\u002F04.security",{"title":220,"path":357,"stem":358,"children":359,"page":53},"\u002Fdocs\u002Fauth-h3client\u002Fguides","docs\u002Fauth-h3client\u002F05.guides",[360,364,368,372],{"title":361,"path":362,"stem":363},"H3 and Nitro Setup","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fh3-nitro","docs\u002Fauth-h3client\u002F05.guides\u002F00.h3-nitro",{"title":365,"path":366,"stem":367},"HMAC Inter-service Auth","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fhmac","docs\u002Fauth-h3client\u002F05.guides\u002Fhmac",{"title":369,"path":370,"stem":371},"Image Upload","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fimage-upload","docs\u002Fauth-h3client\u002F05.guides\u002Fimage-upload",{"title":373,"path":374,"stem":375},"mTLS Configuration","\u002Fdocs\u002Fauth-h3client\u002Fguides\u002Fmtls","docs\u002Fauth-h3client\u002F05.guides\u002Fmtls",{"title":237,"path":377,"stem":378},"\u002Fdocs\u002Fauth-h3client\u002Fconfiguration","docs\u002Fauth-h3client\u002F06.configuration",{"title":246,"path":380,"stem":381,"children":382},"\u002Fdocs\u002Fauth-h3client\u002Fapi","docs\u002Fauth-h3client\u002F07.api\u002Findex",[383,384,387,390,394],{"title":246,"path":380,"stem":381},{"title":254,"path":385,"stem":386},"\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Fcontrollers","docs\u002Fauth-h3client\u002F07.api\u002F00.controllers",{"title":250,"path":388,"stem":389},"\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Fmiddleware","docs\u002Fauth-h3client\u002F07.api\u002F01.middleware",{"title":391,"path":392,"stem":393},"Client-side Reference","\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Fcomposables","docs\u002Fauth-h3client\u002F07.api\u002F02.composables",{"title":395,"path":396,"stem":397},"Utilities","\u002Fdocs\u002Fauth-h3client\u002Fapi\u002Futilities","docs\u002Fauth-h3client\u002F07.api\u002F03.utilities",{"title":399,"path":35,"stem":400,"children":401},"Bot Detector","docs\u002Fbot-detection\u002Findex",[402,403,406,410,414,433,507,510,513],{"title":399,"path":35,"stem":400},{"title":14,"path":404,"stem":405},"\u002Fdocs\u002Fbot-detection\u002Fgetting-started","docs\u002Fbot-detection\u002F00.getting-started",{"title":407,"path":408,"stem":409},"CLI","\u002Fdocs\u002Fbot-detection\u002Fcli","docs\u002Fbot-detection\u002F01.cli",{"title":411,"path":412,"stem":413},"Data Sources","\u002Fdocs\u002Fbot-detection\u002Fdata-sources","docs\u002Fbot-detection\u002F02.data-sources",{"title":220,"path":415,"stem":416,"children":417,"page":53},"\u002Fdocs\u002Fbot-detection\u002Fguides","docs\u002Fbot-detection\u002F03.guides",[418,422,426,429],{"title":419,"path":420,"stem":421},"Custom Checkers","\u002Fdocs\u002Fbot-detection\u002Fguides\u002Fcustom","docs\u002Fbot-detection\u002F03.guides\u002FCUSTOM",{"title":423,"path":424,"stem":425},"Scheduling Database Generation","\u002Fdocs\u002Fbot-detection\u002Fguides\u002Fgenerate","docs\u002Fbot-detection\u002F03.guides\u002FGENERATE",{"title":143,"path":427,"stem":428},"\u002Fdocs\u002Fbot-detection\u002Fguides\u002Flogging","docs\u002Fbot-detection\u002F03.guides\u002FLOGGING",{"title":430,"path":431,"stem":432},"Score Modes and Reputation Healing","\u002Fdocs\u002Fbot-detection\u002Fguides\u002Fscore","docs\u002Fbot-detection\u002F03.guides\u002FSCORE",{"title":434,"path":435,"stem":436,"children":437},"Checkers","\u002Fdocs\u002Fbot-detection\u002Fcheckers","docs\u002Fbot-detection\u002F04.checkers\u002Findex",[438,439,443,447,451,455,459,463,467,471,475,479,483,487,491,495,499,503],{"title":434,"path":435,"stem":436},{"title":440,"path":441,"stem":442},"IP Validation","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fip-validation","docs\u002Fbot-detection\u002F04.checkers\u002F01.ip-validation",{"title":444,"path":445,"stem":446},"Good \u002F Bad Bot Verification","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fgood-bots","docs\u002Fbot-detection\u002F04.checkers\u002F02.good-bots",{"title":448,"path":449,"stem":450},"Browser & Device Fingerprint","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fbrowser-device","docs\u002Fbot-detection\u002F04.checkers\u002F03.browser-device",{"title":452,"path":453,"stem":454},"Locale Map","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Flocale-map","docs\u002Fbot-detection\u002F04.checkers\u002F04.locale-map",{"title":456,"path":457,"stem":458},"Known Threats","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fknown-threats","docs\u002Fbot-detection\u002F04.checkers\u002F05.known-threats",{"title":460,"path":461,"stem":462},"ASN Classification","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fasn-classification","docs\u002Fbot-detection\u002F04.checkers\u002F06.asn-classification",{"title":464,"path":465,"stem":466},"Tor Analysis","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Ftor-analysis","docs\u002Fbot-detection\u002F04.checkers\u002F07.tor-analysis",{"title":468,"path":469,"stem":470},"Timezone Consistency","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Ftimezone-consistency","docs\u002Fbot-detection\u002F04.checkers\u002F08.timezone-consistency",{"title":472,"path":473,"stem":474},"Honeypot","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fhoneypot","docs\u002Fbot-detection\u002F04.checkers\u002F09.honeypot",{"title":476,"path":477,"stem":478},"Known Bad IPs","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fknown-bad-ips","docs\u002Fbot-detection\u002F04.checkers\u002F10.known-bad-ips",{"title":480,"path":481,"stem":482},"Behavior Rate","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fbehavior-rate","docs\u002Fbot-detection\u002F04.checkers\u002F11.behavior-rate",{"title":484,"path":485,"stem":486},"Proxy \u002F ISP \u002F Cookie","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fproxy-isp-cookies","docs\u002Fbot-detection\u002F04.checkers\u002F12.proxy-isp-cookies",{"title":488,"path":489,"stem":490},"Session Coherence","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fsession-coherence","docs\u002Fbot-detection\u002F04.checkers\u002F13.session-coherence",{"title":492,"path":493,"stem":494},"Velocity Fingerprint","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fvelocity-fingerprint","docs\u002Fbot-detection\u002F04.checkers\u002F14.velocity-fingerprint",{"title":496,"path":497,"stem":498},"UA & Header Analysis","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fua-header","docs\u002Fbot-detection\u002F04.checkers\u002F15.ua-header",{"title":500,"path":501,"stem":502},"Geolocation","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fgeolocation","docs\u002Fbot-detection\u002F04.checkers\u002F16.geolocation",{"title":504,"path":505,"stem":506},"Known Bad User-Agents","\u002Fdocs\u002Fbot-detection\u002Fcheckers\u002Fknown-bad-ua","docs\u002Fbot-detection\u002F04.checkers\u002F17.known-bad-ua",{"title":38,"path":508,"stem":509},"\u002Fdocs\u002Fbot-detection\u002Fsecurity","docs\u002Fbot-detection\u002F04.security",{"title":246,"path":511,"stem":512},"\u002Fdocs\u002Fbot-detection\u002Fapi","docs\u002Fbot-detection\u002F05.api",{"title":237,"path":514,"stem":515},"\u002Fdocs\u002Fbot-detection\u002Fconfiguration","docs\u002Fbot-detection\u002F06.configuration",{"title":517,"path":11,"stem":518,"children":519},"Introduction","docs\u002Fgetting-started\u002Findex",[520],{"title":517,"path":11,"stem":518},{"title":27,"path":29,"stem":70,"children":522},[523,524,525,565,566,571,572],{"title":27,"path":29,"stem":70},{"title":14,"path":74,"stem":75},{"title":77,"path":78,"stem":79,"children":526},[527,528,529,530,531,532,533,534,535,536,537,538,539,540,541,542,543,544,545,546,547,548,549],{"title":77,"path":78,"stem":79},{"title":83,"path":84,"stem":85},{"title":87,"path":88,"stem":89},{"title":91,"path":92,"stem":93},{"title":95,"path":96,"stem":97},{"title":99,"path":100,"stem":101},{"title":103,"path":104,"stem":105},{"title":107,"path":108,"stem":109},{"title":111,"path":112,"stem":113},{"title":115,"path":116,"stem":117},{"title":119,"path":120,"stem":121},{"title":123,"path":124,"stem":125},{"title":127,"path":128,"stem":129},{"title":131,"path":132,"stem":133},{"title":135,"path":136,"stem":137},{"title":139,"path":140,"stem":141},{"title":143,"path":144,"stem":145},{"title":147,"path":148,"stem":149},{"title":151,"path":152,"stem":153},{"title":155,"path":156,"stem":157},{"title":159,"path":160,"stem":161},{"title":163,"path":164,"stem":165},{"title":167,"path":168,"stem":169,"children":550},[551,552,553,554,563,564],{"title":167,"path":168,"stem":169},{"title":173,"path":174,"stem":175},{"title":177,"path":178,"stem":179},{"title":181,"path":182,"stem":183,"children":555},[556,557,558,559,560,561,562],{"title":181,"path":182,"stem":183},{"title":187,"path":188,"stem":189},{"title":191,"path":192,"stem":193},{"title":195,"path":196,"stem":197},{"title":199,"path":200,"stem":201},{"title":203,"path":204,"stem":205},{"title":207,"path":208,"stem":209},{"title":147,"path":211,"stem":212},{"title":38,"path":214,"stem":215},{"title":38,"path":217,"stem":218},{"title":220,"path":221,"stem":222,"children":567,"page":53},[568,569,570],{"title":225,"path":226,"stem":227},{"title":229,"path":230,"stem":231},{"title":233,"path":234,"stem":235},{"title":237,"path":238,"stem":239},{"title":241,"path":242,"stem":243,"children":573,"page":53},[574,575,576],{"title":246,"path":247,"stem":248},{"title":250,"path":251,"stem":252},{"title":254,"path":255,"stem":256},{"title":40,"path":42,"stem":578,"children":579},"docs\u002Fshield-base\u002Findex",[580,581,584,588,629,633,637,641],{"title":40,"path":42,"stem":578},{"title":14,"path":582,"stem":583},"\u002Fdocs\u002Fshield-base\u002Fgetting-started","docs\u002Fshield-base\u002F00.getting-started",{"title":585,"path":586,"stem":587},"CLI Reference","\u002Fdocs\u002Fshield-base\u002Fcli","docs\u002Fshield-base\u002F01.cli",{"title":411,"path":589,"stem":590,"children":591},"\u002Fdocs\u002Fshield-base\u002Fdata-sources","docs\u002Fshield-base\u002F02.data-sources\u002Findex",[592,593,597,601,605,609,613,617,621,625],{"title":411,"path":589,"stem":590},{"title":594,"path":595,"stem":596},"BGP \u002F ASN","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fbgp","docs\u002Fshield-base\u002F02.data-sources\u002Fbgp",{"title":598,"path":599,"stem":600},"City Geolocation","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fcity","docs\u002Fshield-base\u002F02.data-sources\u002Fcity",{"title":602,"path":603,"stem":604},"Country Geolocation","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fcountry","docs\u002Fshield-base\u002F02.data-sources\u002Fcountry",{"title":606,"path":607,"stem":608},"Verified Crawlers","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fcrawlers","docs\u002Fshield-base\u002F02.data-sources\u002Fcrawlers",{"title":610,"path":611,"stem":612},"Disposable Emails","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Femail","docs\u002Fshield-base\u002F02.data-sources\u002Femail",{"title":614,"path":615,"stem":616},"FireHOL Threat Intelligence","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Ffirehol","docs\u002Fshield-base\u002F02.data-sources\u002Ffirehol",{"title":618,"path":619,"stem":620},"Proxy Detection","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fproxy","docs\u002Fshield-base\u002F02.data-sources\u002Fproxy",{"title":622,"path":623,"stem":624},"Tor Nodes","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Ftor","docs\u002Fshield-base\u002F02.data-sources\u002Ftor",{"title":626,"path":627,"stem":628},"Suspicious User-Agents","\u002Fdocs\u002Fshield-base\u002Fdata-sources\u002Fuseragent","docs\u002Fshield-base\u002F02.data-sources\u002Fuseragent",{"title":630,"path":631,"stem":632},"Programmatic Usage","\u002Fdocs\u002Fshield-base\u002Fusage","docs\u002Fshield-base\u002F03.usage",{"title":634,"path":635,"stem":636},"Custom Data Sources","\u002Fdocs\u002Fshield-base\u002Fcustom-data-sources","docs\u002Fshield-base\u002F04.custom-data-sources",{"title":638,"path":639,"stem":640},"TypeScript Types","\u002Fdocs\u002Fshield-base\u002Ftypes","docs\u002Fshield-base\u002F05.types",{"title":246,"path":642,"stem":643},"\u002Fdocs\u002Fshield-base\u002Fapi","docs\u002Fshield-base\u002F06.api",{"title":395,"path":48,"stem":645,"children":646},"docs\u002Futils\u002Findex",[647,648,665,698,795],{"title":395,"path":48,"stem":645},{"title":649,"path":650,"stem":651,"children":652,"page":53},"Eslint","\u002Fdocs\u002Futils\u002Feslint","docs\u002Futils\u002Feslint",[653,657,661],{"title":654,"path":655,"stem":656},"React Config","\u002Fdocs\u002Futils\u002Feslint\u002Freact","docs\u002Futils\u002Feslint\u002Freact",{"title":658,"path":659,"stem":660},"TypeScript Config","\u002Fdocs\u002Futils\u002Feslint\u002Ftypescript","docs\u002Futils\u002Feslint\u002Ftypescript",{"title":662,"path":663,"stem":664},"Vue Config","\u002Fdocs\u002Futils\u002Feslint\u002Fvue","docs\u002Futils\u002Feslint\u002Fvue",{"title":666,"path":667,"stem":668,"children":669,"page":53},"Server","\u002Fdocs\u002Futils\u002Fserver","docs\u002Futils\u002Fserver",[670,674,678,682,686,690,694],{"title":671,"path":672,"stem":673},"Encryption","\u002Fdocs\u002Futils\u002Fserver\u002Fencryption","docs\u002Futils\u002Fserver\u002Fencryption",{"title":675,"path":676,"stem":677},"Path Resolver","\u002Fdocs\u002Futils\u002Fserver\u002Fpathresolver","docs\u002Futils\u002Fserver\u002FpathResolver",{"title":679,"path":680,"stem":681},"File Replacements","\u002Fdocs\u002Futils\u002Fserver\u002Freplace","docs\u002Futils\u002Fserver\u002Freplace",{"title":683,"path":684,"stem":685},"run","\u002Fdocs\u002Futils\u002Fserver\u002Frun","docs\u002Futils\u002Fserver\u002Frun",{"title":687,"path":688,"stem":689},"scheduleTask","\u002Fdocs\u002Futils\u002Fserver\u002Fscheduletask","docs\u002Futils\u002Fserver\u002FscheduleTask",{"title":691,"path":692,"stem":693},"spawnRun","\u002Fdocs\u002Futils\u002Fserver\u002Fspawnrun","docs\u002Futils\u002Fserver\u002FspawnRun",{"title":695,"path":696,"stem":697},"uploadCsv","\u002Fdocs\u002Futils\u002Fserver\u002Fuploadcsv","docs\u002Futils\u002Fserver\u002FuploadCsv",{"title":699,"path":700,"stem":701,"children":702,"page":53},"Shared","\u002Fdocs\u002Futils\u002Fshared","docs\u002Futils\u002Fshared",[703,707,711,715,719,723,727,731,735,739,743,747,751,755,759,763,767,771,775,779,783,787,791],{"title":704,"path":705,"stem":706},"BatchQueue","\u002Fdocs\u002Futils\u002Fshared\u002Fbatchqueue","docs\u002Futils\u002Fshared\u002FbatchQueue",{"title":708,"path":709,"stem":710},"capitalize","\u002Fdocs\u002Futils\u002Fshared\u002Fcapitalize","docs\u002Futils\u002Fshared\u002Fcapitalize",{"title":712,"path":713,"stem":714},"chunkProcess","\u002Fdocs\u002Futils\u002Fshared\u002Fchunkprocess","docs\u002Futils\u002Fshared\u002FchunkProcess",{"title":716,"path":717,"stem":718},"cleanObject","\u002Fdocs\u002Futils\u002Fshared\u002Fcleanobject","docs\u002Futils\u002Fshared\u002FcleanObject",{"title":720,"path":721,"stem":722},"createConfigManager","\u002Fdocs\u002Futils\u002Fshared\u002Fconfigurationdefiner","docs\u002Futils\u002Fshared\u002FconfigurationDefiner",{"title":724,"path":725,"stem":726},"debounce","\u002Fdocs\u002Futils\u002Fshared\u002Fdebounce","docs\u002Futils\u002Fshared\u002Fdebounce",{"title":728,"path":729,"stem":730},"ensureArray","\u002Fdocs\u002Futils\u002Fshared\u002Fensurearray","docs\u002Futils\u002Fshared\u002FensureArray",{"title":732,"path":733,"stem":734},"fetchWithRetry","\u002Fdocs\u002Futils\u002Fshared\u002Ffetchwithretry","docs\u002Futils\u002Fshared\u002FfetchWithRetry",{"title":736,"path":737,"stem":738},"filterEmptyValues","\u002Fdocs\u002Futils\u002Fshared\u002Ffilteremptyvalues","docs\u002Futils\u002Fshared\u002FfilterEmptyValues",{"title":740,"path":741,"stem":742},"findStringsInObject","\u002Fdocs\u002Futils\u002Fshared\u002Ffindobjectvalues","docs\u002Futils\u002Fshared\u002FfindObjectValues",{"title":744,"path":745,"stem":746},"fisherYatesShuffle","\u002Fdocs\u002Futils\u002Fshared\u002Ffisheryatesshuffle","docs\u002Futils\u002Fshared\u002FfisherYatesShuffle",{"title":748,"path":749,"stem":750},"getRandomImage","\u002Fdocs\u002Futils\u002Fshared\u002Fgetrandomimage","docs\u002Futils\u002Fshared\u002FgetRandomImage",{"title":752,"path":753,"stem":754},"isObjectHasValues","\u002Fdocs\u002Futils\u002Fshared\u002Fisobjecthasvalues","docs\u002Futils\u002Fshared\u002FisObjectHasValues",{"title":756,"path":757,"stem":758},"isAsyncOrPromise","\u002Fdocs\u002Futils\u002Fshared\u002Fispromise","docs\u002Futils\u002Fshared\u002FisPromise",{"title":760,"path":761,"stem":762},"MiniCache","\u002Fdocs\u002Futils\u002Fshared\u002Fminicache","docs\u002Futils\u002Fshared\u002FminiCache",{"title":764,"path":765,"stem":766},"parseCookies","\u002Fdocs\u002Futils\u002Fshared\u002Fparserawcookies","docs\u002Futils\u002Fshared\u002FparseRawCookies",{"title":768,"path":769,"stem":770},"safeAction","\u002Fdocs\u002Futils\u002Fshared\u002Fpromiselocker","docs\u002Futils\u002Fshared\u002FpromiseLocker",{"title":772,"path":773,"stem":774},"Random","\u002Fdocs\u002Futils\u002Fshared\u002Frandom","docs\u002Futils\u002Fshared\u002Frandom",{"title":776,"path":777,"stem":778},"range","\u002Fdocs\u002Futils\u002Fshared\u002Frange","docs\u002Futils\u002Fshared\u002Frange",{"title":780,"path":781,"stem":782},"rateLimiters","\u002Fdocs\u002Futils\u002Fshared\u002Fratelimiters","docs\u002Futils\u002Fshared\u002FrateLimiters",{"title":784,"path":785,"stem":786},"safeObjectMerge","\u002Fdocs\u002Futils\u002Fshared\u002Fsafemerge","docs\u002Futils\u002Fshared\u002FsafeMerge",{"title":788,"path":789,"stem":790},"textTruncation","\u002Fdocs\u002Futils\u002Fshared\u002Ftexttruncation","docs\u002Futils\u002Fshared\u002FtextTruncation",{"title":792,"path":793,"stem":794},"validateZodSchema","\u002Fdocs\u002Futils\u002Fshared\u002Fvalidatezodschema","docs\u002Futils\u002Fshared\u002FvalidateZodSchema",{"title":796,"path":797,"stem":798,"children":799},"Utility Types","\u002Fdocs\u002Futils\u002Ftypes","docs\u002Futils\u002Ftypes\u002Findex",[800,801,805,809,813,817,821,825,829,833],{"title":796,"path":797,"stem":798},{"title":802,"path":803,"stem":804},"Brand","\u002Fdocs\u002Futils\u002Ftypes\u002Fbrand","docs\u002Futils\u002Ftypes\u002FBrand",{"title":806,"path":807,"stem":808},"DeepPartial","\u002Fdocs\u002Futils\u002Ftypes\u002Fdeeppartial","docs\u002Futils\u002Ftypes\u002FDeepPartial",{"title":810,"path":811,"stem":812},"Merge","\u002Fdocs\u002Futils\u002Ftypes\u002Fmerge","docs\u002Futils\u002Ftypes\u002FMerge",{"title":814,"path":815,"stem":816},"NonNullable","\u002Fdocs\u002Futils\u002Ftypes\u002Fnonnullable","docs\u002Futils\u002Ftypes\u002FNonNullable",{"title":818,"path":819,"stem":820},"Prettify","\u002Fdocs\u002Futils\u002Ftypes\u002Fprettify","docs\u002Futils\u002Ftypes\u002FPrettify",{"title":822,"path":823,"stem":824},"PromiseType","\u002Fdocs\u002Futils\u002Ftypes\u002Fpromisetype","docs\u002Futils\u002Ftypes\u002FPromiseType",{"title":826,"path":827,"stem":828},"RequireKeys","\u002Fdocs\u002Futils\u002Ftypes\u002Frequirekeys","docs\u002Futils\u002Ftypes\u002FRequireKeys",{"title":830,"path":831,"stem":832},"StandardResponse","\u002Fdocs\u002Futils\u002Ftypes\u002Fstandardresponse","docs\u002Futils\u002Ftypes\u002FStandardResponse",{"title":834,"path":835,"stem":836},"ValueOf","\u002Fdocs\u002Futils\u002Ftypes\u002Fvalueof","docs\u002Futils\u002Ftypes\u002FValueOf",{"id":4,"extension":5,"links":838,"meta":849,"stem":62,"__hash__":63},[839,847,848],{"nested":8,"label":9,"icon":10,"to":11,"children":840},[841,842,843,844,845,846],{"label":14,"icon":15,"to":11,"description":16,"github":17,"badge":18},{"label":20,"icon":21,"to":22,"description":23,"github":24,"badge":25},{"label":27,"icon":28,"to":29,"description":30,"github":31,"badge":25},{"label":33,"icon":34,"to":35,"description":36,"github":37,"badge":38},{"label":40,"icon":41,"to":42,"description":43,"github":44,"badge":38},{"label":46,"icon":47,"to":48,"description":49,"github":50,"badge":51},{"nested":53,"label":54,"icon":55,"to":56},{"nested":53,"label":58,"icon":59,"to":60},{},{"id":851,"title":177,"body":852,"description":2924,"extension":2925,"icon":2926,"meta":2927,"module":2928,"navigation":8,"path":178,"rawbody":2929,"seo":2930,"stem":179,"__hash__":2931},"docs\u002Fdocs\u002Fiam\u002F01.essentials\u002F21.api\u002F01.verification.md",{"type":853,"value":854,"toc":2904},"minimark",[855,859,871,877,884,889,892,897,902,905,938,949,952,1228,1233,1239,1329,1332,1420,1423,1507,1510,1563,1566,1652,1655,1737,1743,1747,1750,1811,1813,1817,1822,1983,1986,1990,2124,2128,2280,2283,2425,2428,2476,2485,2500,2518,2520,2524,2530,2534,2537,2566,2570,2577,2581,2588,2605,2617,2620,2630,2644,2648,2655,2671,2675,2678,2703,2705,2709,2712,2725,2730,2766,2770,2808,2810,2814,2898,2900],[856,857,858],"p",{},"API token verification is the public M2M entry point for validating a token against the IAM and checking if it is allowed to perform a given privilege.",[856,860,861,862,866,867,870],{},"If using the service a caller must send the raw API key in the ",[863,864,865],"code",{},"x-api-key"," header and request a privilege scope through the ",[863,868,869],{},"privilege"," query parameter. The service then validates the token structure.",[872,873,874],"note",{},[856,875,876],{},"The endpoint is not behind any authentication flow, MFA's or bot detections, it verify the given token and gets out of the way.",[856,878,879,880,883],{},"If using the library, you call ",[863,881,882],{},"verifyApiKey"," with the appropriate parameters, depending on your needs and use case.",[872,885,886],{},[856,887,888],{},"The token will be verified against the attributes you defined in the creation step",[890,891],"hr",{},[893,894,896],"h2",{"id":895},"verifying-a-token","Verifying a token",[898,899,901],"h3",{"id":900},"using-the-route","Using the route",[856,903,904],{},"The verification route is available at:",[906,907,912],"pre",{"className":908,"code":909,"language":910,"meta":911,"style":911},"language-http shiki shiki-themes light-plus light-plus dracula","GET \u002Fapi\u002Fpublic\u002Fverify?privilege=\u003Cprivilege> HTTP\u002F1.1\n","http","",[863,913,914],{"__ignoreMap":911},[915,916,919,923,927,931,934],"span",{"class":917,"line":918},"line",1,[915,920,922],{"class":921},"sZ328","GET",[915,924,926],{"class":925},"sDd4n"," \u002Fapi\u002Fpublic\u002Fverify?privilege=\u003Cprivilege> ",[915,928,930],{"class":929},"sl46w","HTTP",[915,932,933],{"class":925},"\u002F",[915,935,937],{"class":936},"spgvN","1.1\n",[856,939,940,941,943,944,948],{},"Send the token in the ",[863,942,865],{}," header with the privilege you defined at the ",[945,946,947],"a",{"href":174},"creation step"," of the token.",[856,950,951],{},"On success the response will be:",[906,953,955],{"className":908,"code":954,"language":910,"meta":911,"style":911},"HTTP\u002F1.1 200 OK\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": true,\n  \"date\": \"current date\",\n  \"data\": {\n    \"name\": \"mytoken\",\n    \"tokenId\": 12,\n    \"userId\": 42,\n    \"createdAt\": \"2026-04-30T10:00:00.000Z\",\n    \"expiresAt\": \"2026-04-30T11:00:00.000Z\",\n    \"lastUsed\": \"2026-04-30T10:12:00.000Z\",\n    \"usageCount\": 7,\n    \"providedPrivilege\": \"verified privilege\"\n  }\n}\n",[863,956,957,973,986,992,998,1022,1045,1060,1082,1099,1116,1137,1158,1179,1196,1216,1222],{"__ignoreMap":911},[915,958,959,961,963,966,969],{"class":917,"line":918},[915,960,930],{"class":929},[915,962,933],{"class":925},[915,964,965],{"class":936},"1.1",[915,967,968],{"class":936}," 200",[915,970,972],{"class":971},"sFB1V"," OK\n",[915,974,976,980,983],{"class":917,"line":975},2,[915,977,979],{"class":978},"scd-l","Content-Type",[915,981,982],{"class":929},":",[915,984,985],{"class":971}," application\u002Fjson; charset=utf-8\n",[915,987,989],{"class":917,"line":988},3,[915,990,991],{"emptyLinePlaceholder":8},"\n",[915,993,995],{"class":917,"line":994},4,[915,996,997],{"class":925},"{\n",[915,999,1001,1005,1009,1012,1015,1019],{"class":917,"line":1000},5,[915,1002,1004],{"class":1003},"saJyd","  \"",[915,1006,1008],{"class":1007},"s_W10","ok",[915,1010,1011],{"class":1003},"\"",[915,1013,982],{"class":1014},"saOXh",[915,1016,1018],{"class":1017},"sjR7W"," true",[915,1020,1021],{"class":925},",\n",[915,1023,1025,1027,1030,1032,1034,1038,1041,1043],{"class":917,"line":1024},6,[915,1026,1004],{"class":1003},[915,1028,1029],{"class":1007},"date",[915,1031,1011],{"class":1003},[915,1033,982],{"class":1014},[915,1035,1037],{"class":1036},"sFkSl"," \"",[915,1039,1040],{"class":971},"current date",[915,1042,1011],{"class":1036},[915,1044,1021],{"class":925},[915,1046,1048,1050,1053,1055,1057],{"class":917,"line":1047},7,[915,1049,1004],{"class":1003},[915,1051,1052],{"class":1007},"data",[915,1054,1011],{"class":1003},[915,1056,982],{"class":1014},[915,1058,1059],{"class":925}," {\n",[915,1061,1063,1066,1069,1071,1073,1075,1078,1080],{"class":917,"line":1062},8,[915,1064,1065],{"class":1003},"    \"",[915,1067,1068],{"class":1007},"name",[915,1070,1011],{"class":1003},[915,1072,982],{"class":1014},[915,1074,1037],{"class":1036},[915,1076,1077],{"class":971},"mytoken",[915,1079,1011],{"class":1036},[915,1081,1021],{"class":925},[915,1083,1085,1087,1090,1092,1094,1097],{"class":917,"line":1084},9,[915,1086,1065],{"class":1003},[915,1088,1089],{"class":1007},"tokenId",[915,1091,1011],{"class":1003},[915,1093,982],{"class":1014},[915,1095,1096],{"class":936}," 12",[915,1098,1021],{"class":925},[915,1100,1102,1104,1107,1109,1111,1114],{"class":917,"line":1101},10,[915,1103,1065],{"class":1003},[915,1105,1106],{"class":1007},"userId",[915,1108,1011],{"class":1003},[915,1110,982],{"class":1014},[915,1112,1113],{"class":936}," 42",[915,1115,1021],{"class":925},[915,1117,1119,1121,1124,1126,1128,1130,1133,1135],{"class":917,"line":1118},11,[915,1120,1065],{"class":1003},[915,1122,1123],{"class":1007},"createdAt",[915,1125,1011],{"class":1003},[915,1127,982],{"class":1014},[915,1129,1037],{"class":1036},[915,1131,1132],{"class":971},"2026-04-30T10:00:00.000Z",[915,1134,1011],{"class":1036},[915,1136,1021],{"class":925},[915,1138,1140,1142,1145,1147,1149,1151,1154,1156],{"class":917,"line":1139},12,[915,1141,1065],{"class":1003},[915,1143,1144],{"class":1007},"expiresAt",[915,1146,1011],{"class":1003},[915,1148,982],{"class":1014},[915,1150,1037],{"class":1036},[915,1152,1153],{"class":971},"2026-04-30T11:00:00.000Z",[915,1155,1011],{"class":1036},[915,1157,1021],{"class":925},[915,1159,1161,1163,1166,1168,1170,1172,1175,1177],{"class":917,"line":1160},13,[915,1162,1065],{"class":1003},[915,1164,1165],{"class":1007},"lastUsed",[915,1167,1011],{"class":1003},[915,1169,982],{"class":1014},[915,1171,1037],{"class":1036},[915,1173,1174],{"class":971},"2026-04-30T10:12:00.000Z",[915,1176,1011],{"class":1036},[915,1178,1021],{"class":925},[915,1180,1182,1184,1187,1189,1191,1194],{"class":917,"line":1181},14,[915,1183,1065],{"class":1003},[915,1185,1186],{"class":1007},"usageCount",[915,1188,1011],{"class":1003},[915,1190,982],{"class":1014},[915,1192,1193],{"class":936}," 7",[915,1195,1021],{"class":925},[915,1197,1199,1201,1204,1206,1208,1210,1213],{"class":917,"line":1198},15,[915,1200,1065],{"class":1003},[915,1202,1203],{"class":1007},"providedPrivilege",[915,1205,1011],{"class":1003},[915,1207,982],{"class":1014},[915,1209,1037],{"class":1036},[915,1211,1212],{"class":971},"verified privilege",[915,1214,1215],{"class":1036},"\"\n",[915,1217,1219],{"class":917,"line":1218},16,[915,1220,1221],{"class":925},"  }\n",[915,1223,1225],{"class":917,"line":1224},17,[915,1226,1227],{"class":925},"}\n",[1229,1230,1232],"h4",{"id":1231},"failed-responses","Failed responses",[856,1234,1235,1236,1238],{},"If the ",[863,1237,865],{}," header is missing or malformed, the route returns:",[906,1240,1242],{"className":908,"code":1241,"language":910,"meta":911,"style":911},"HTTP\u002F1.1 401 Unauthorized\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": false,\n  \"date\": \"current date\",\n  \"reason\": \"No api key provided\"\n}\n",[863,1243,1244,1258,1266,1270,1274,1289,1307,1325],{"__ignoreMap":911},[915,1245,1246,1248,1250,1252,1255],{"class":917,"line":918},[915,1247,930],{"class":929},[915,1249,933],{"class":925},[915,1251,965],{"class":936},[915,1253,1254],{"class":936}," 401",[915,1256,1257],{"class":971}," Unauthorized\n",[915,1259,1260,1262,1264],{"class":917,"line":975},[915,1261,979],{"class":978},[915,1263,982],{"class":929},[915,1265,985],{"class":971},[915,1267,1268],{"class":917,"line":988},[915,1269,991],{"emptyLinePlaceholder":8},[915,1271,1272],{"class":917,"line":994},[915,1273,997],{"class":925},[915,1275,1276,1278,1280,1282,1284,1287],{"class":917,"line":1000},[915,1277,1004],{"class":1003},[915,1279,1008],{"class":1007},[915,1281,1011],{"class":1003},[915,1283,982],{"class":1014},[915,1285,1286],{"class":1017}," false",[915,1288,1021],{"class":925},[915,1290,1291,1293,1295,1297,1299,1301,1303,1305],{"class":917,"line":1024},[915,1292,1004],{"class":1003},[915,1294,1029],{"class":1007},[915,1296,1011],{"class":1003},[915,1298,982],{"class":1014},[915,1300,1037],{"class":1036},[915,1302,1040],{"class":971},[915,1304,1011],{"class":1036},[915,1306,1021],{"class":925},[915,1308,1309,1311,1314,1316,1318,1320,1323],{"class":917,"line":1047},[915,1310,1004],{"class":1003},[915,1312,1313],{"class":1007},"reason",[915,1315,1011],{"class":1003},[915,1317,982],{"class":1014},[915,1319,1037],{"class":1036},[915,1321,1322],{"class":971},"No api key provided",[915,1324,1215],{"class":1036},[915,1326,1327],{"class":917,"line":1062},[915,1328,1227],{"class":925},[856,1330,1331],{},"If the server cannot resolve the caller IP, the route returns:",[906,1333,1335],{"className":908,"code":1334,"language":910,"meta":911,"style":911},"HTTP\u002F1.1 400 Bad Request\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": false,\n  \"date\": \"current date\",\n  \"reason\": \"Bad Request\"\n}\n",[863,1336,1337,1351,1359,1363,1367,1381,1399,1416],{"__ignoreMap":911},[915,1338,1339,1341,1343,1345,1348],{"class":917,"line":918},[915,1340,930],{"class":929},[915,1342,933],{"class":925},[915,1344,965],{"class":936},[915,1346,1347],{"class":936}," 400",[915,1349,1350],{"class":971}," Bad Request\n",[915,1352,1353,1355,1357],{"class":917,"line":975},[915,1354,979],{"class":978},[915,1356,982],{"class":929},[915,1358,985],{"class":971},[915,1360,1361],{"class":917,"line":988},[915,1362,991],{"emptyLinePlaceholder":8},[915,1364,1365],{"class":917,"line":994},[915,1366,997],{"class":925},[915,1368,1369,1371,1373,1375,1377,1379],{"class":917,"line":1000},[915,1370,1004],{"class":1003},[915,1372,1008],{"class":1007},[915,1374,1011],{"class":1003},[915,1376,982],{"class":1014},[915,1378,1286],{"class":1017},[915,1380,1021],{"class":925},[915,1382,1383,1385,1387,1389,1391,1393,1395,1397],{"class":917,"line":1024},[915,1384,1004],{"class":1003},[915,1386,1029],{"class":1007},[915,1388,1011],{"class":1003},[915,1390,982],{"class":1014},[915,1392,1037],{"class":1036},[915,1394,1040],{"class":971},[915,1396,1011],{"class":1036},[915,1398,1021],{"class":925},[915,1400,1401,1403,1405,1407,1409,1411,1414],{"class":917,"line":1047},[915,1402,1004],{"class":1003},[915,1404,1313],{"class":1007},[915,1406,1011],{"class":1003},[915,1408,982],{"class":1014},[915,1410,1037],{"class":1036},[915,1412,1413],{"class":971},"Bad Request",[915,1415,1215],{"class":1036},[915,1417,1418],{"class":917,"line":1062},[915,1419,1227],{"class":925},[856,1421,1422],{},"If the query parameter does not match the allowed privilege schema, the route returns:",[906,1424,1425],{"className":908,"code":1334,"language":910,"meta":911,"style":911},[863,1426,1427,1439,1447,1451,1455,1469,1487,1503],{"__ignoreMap":911},[915,1428,1429,1431,1433,1435,1437],{"class":917,"line":918},[915,1430,930],{"class":929},[915,1432,933],{"class":925},[915,1434,965],{"class":936},[915,1436,1347],{"class":936},[915,1438,1350],{"class":971},[915,1440,1441,1443,1445],{"class":917,"line":975},[915,1442,979],{"class":978},[915,1444,982],{"class":929},[915,1446,985],{"class":971},[915,1448,1449],{"class":917,"line":988},[915,1450,991],{"emptyLinePlaceholder":8},[915,1452,1453],{"class":917,"line":994},[915,1454,997],{"class":925},[915,1456,1457,1459,1461,1463,1465,1467],{"class":917,"line":1000},[915,1458,1004],{"class":1003},[915,1460,1008],{"class":1007},[915,1462,1011],{"class":1003},[915,1464,982],{"class":1014},[915,1466,1286],{"class":1017},[915,1468,1021],{"class":925},[915,1470,1471,1473,1475,1477,1479,1481,1483,1485],{"class":917,"line":1024},[915,1472,1004],{"class":1003},[915,1474,1029],{"class":1007},[915,1476,1011],{"class":1003},[915,1478,982],{"class":1014},[915,1480,1037],{"class":1036},[915,1482,1040],{"class":971},[915,1484,1011],{"class":1036},[915,1486,1021],{"class":925},[915,1488,1489,1491,1493,1495,1497,1499,1501],{"class":917,"line":1047},[915,1490,1004],{"class":1003},[915,1492,1313],{"class":1007},[915,1494,1011],{"class":1003},[915,1496,982],{"class":1014},[915,1498,1037],{"class":1036},[915,1500,1413],{"class":971},[915,1502,1215],{"class":1036},[915,1504,1505],{"class":917,"line":1062},[915,1506,1227],{"class":925},[856,1508,1509],{},"The input is detected as an XSS attempt, the service bans the request:",[906,1511,1513],{"className":908,"code":1512,"language":910,"meta":911,"style":911},"HTTP\u002F1.1 403 Forbidden\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"banned\": true\n}\n",[863,1514,1515,1529,1537,1541,1545,1559],{"__ignoreMap":911},[915,1516,1517,1519,1521,1523,1526],{"class":917,"line":918},[915,1518,930],{"class":929},[915,1520,933],{"class":925},[915,1522,965],{"class":936},[915,1524,1525],{"class":936}," 403",[915,1527,1528],{"class":971}," Forbidden\n",[915,1530,1531,1533,1535],{"class":917,"line":975},[915,1532,979],{"class":978},[915,1534,982],{"class":929},[915,1536,985],{"class":971},[915,1538,1539],{"class":917,"line":988},[915,1540,991],{"emptyLinePlaceholder":8},[915,1542,1543],{"class":917,"line":994},[915,1544,997],{"class":925},[915,1546,1547,1549,1552,1554,1556],{"class":917,"line":1000},[915,1548,1004],{"class":1003},[915,1550,1551],{"class":1007},"banned",[915,1553,1011],{"class":1003},[915,1555,982],{"class":1014},[915,1557,1558],{"class":1017}," true\n",[915,1560,1561],{"class":917,"line":1024},[915,1562,1227],{"class":925},[856,1564,1565],{},"The token is malformed, expired, revoked, missing, or has the wrong privilege, the route returns:",[906,1567,1569],{"className":908,"code":1568,"language":910,"meta":911,"style":911},"HTTP\u002F1.1 401 Unauthorized\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": false,\n  \"date\": \"current date\",\n  \"reason\": \"Invalid key\"\n}\n",[863,1570,1571,1583,1591,1595,1599,1613,1631,1648],{"__ignoreMap":911},[915,1572,1573,1575,1577,1579,1581],{"class":917,"line":918},[915,1574,930],{"class":929},[915,1576,933],{"class":925},[915,1578,965],{"class":936},[915,1580,1254],{"class":936},[915,1582,1257],{"class":971},[915,1584,1585,1587,1589],{"class":917,"line":975},[915,1586,979],{"class":978},[915,1588,982],{"class":929},[915,1590,985],{"class":971},[915,1592,1593],{"class":917,"line":988},[915,1594,991],{"emptyLinePlaceholder":8},[915,1596,1597],{"class":917,"line":994},[915,1598,997],{"class":925},[915,1600,1601,1603,1605,1607,1609,1611],{"class":917,"line":1000},[915,1602,1004],{"class":1003},[915,1604,1008],{"class":1007},[915,1606,1011],{"class":1003},[915,1608,982],{"class":1014},[915,1610,1286],{"class":1017},[915,1612,1021],{"class":925},[915,1614,1615,1617,1619,1621,1623,1625,1627,1629],{"class":917,"line":1024},[915,1616,1004],{"class":1003},[915,1618,1029],{"class":1007},[915,1620,1011],{"class":1003},[915,1622,982],{"class":1014},[915,1624,1037],{"class":1036},[915,1626,1040],{"class":971},[915,1628,1011],{"class":1036},[915,1630,1021],{"class":925},[915,1632,1633,1635,1637,1639,1641,1643,1646],{"class":917,"line":1047},[915,1634,1004],{"class":1003},[915,1636,1313],{"class":1007},[915,1638,1011],{"class":1003},[915,1640,982],{"class":1014},[915,1642,1037],{"class":1036},[915,1644,1645],{"class":971},"Invalid key",[915,1647,1215],{"class":1036},[915,1649,1650],{"class":917,"line":1062},[915,1651,1227],{"class":925},[856,1653,1654],{},"Rate limits:",[906,1656,1658],{"className":908,"code":1657,"language":910,"meta":911,"style":911},"HTTP\u002F1.1 429\nContent-Type: application\u002Fjson; charset=utf-8\nRetry-After: number\n{\n  \"error\": \"Too many requests\",\n  \"retry\": \"number\",\n}\n",[863,1659,1660,1671,1679,1689,1693,1713,1733],{"__ignoreMap":911},[915,1661,1662,1664,1666,1668],{"class":917,"line":918},[915,1663,930],{"class":929},[915,1665,933],{"class":925},[915,1667,965],{"class":936},[915,1669,1670],{"class":936}," 429\n",[915,1672,1673,1675,1677],{"class":917,"line":975},[915,1674,979],{"class":978},[915,1676,982],{"class":929},[915,1678,985],{"class":971},[915,1680,1681,1684,1686],{"class":917,"line":988},[915,1682,1683],{"class":978},"Retry-After",[915,1685,982],{"class":929},[915,1687,1688],{"class":971}," number\n",[915,1690,1691],{"class":917,"line":994},[915,1692,997],{"class":925},[915,1694,1695,1697,1700,1702,1704,1706,1709,1711],{"class":917,"line":1000},[915,1696,1004],{"class":1003},[915,1698,1699],{"class":1007},"error",[915,1701,1011],{"class":1003},[915,1703,982],{"class":1014},[915,1705,1037],{"class":1036},[915,1707,1708],{"class":971},"Too many requests",[915,1710,1011],{"class":1036},[915,1712,1021],{"class":925},[915,1714,1715,1717,1720,1722,1724,1726,1729,1731],{"class":917,"line":1024},[915,1716,1004],{"class":1003},[915,1718,1719],{"class":1007},"retry",[915,1721,1011],{"class":1003},[915,1723,982],{"class":1014},[915,1725,1037],{"class":1036},[915,1727,1728],{"class":971},"number",[915,1730,1011],{"class":1036},[915,1732,1021],{"class":925},[915,1734,1735],{"class":917,"line":1047},[915,1736,1227],{"class":925},[1738,1739,1740],"caution",{},[856,1741,1742],{},"This endpoint is designed for machine-to-machine use. Do not expose raw API keys in client-side code unless the client is fully trusted and isolated from users.",[1229,1744,1746],{"id":1745},"rate-limits","Rate limits",[856,1748,1749],{},"The route is not behind any authentication or middlewares. its protected solely by rate limiters that differentiate between \"probing\" (failures) and \"usage\" (success):",[1751,1752,1753,1773],"ul",{},[1754,1755,1756,1759,1760,1763,1764,1768,1769,1772],"li",{},[863,1757,1758],{},"rate_limiters.apiTokensLimiters.consumptionRateLimiter"," - The main limiter for the failure mode. It will consume a ",[863,1761,1762],{},"point"," on ",[1765,1766,1767],"em",{},"Every"," failed attempt of verification. On success it will be restarted, which means the client, whose not been rate limited by it, could continue send ",[1765,1770,1771],{},"valid"," verified requests. The limiter enforces 10 requests in a 1 minute window, that will ban for 1 hour if this threshold is reached. No consecutive attempts is provided, which means violating this rule will result in a permanent ban.",[1754,1774,1775,1778,1779,1782,1783,1786,1787,1793,1794,1798,1799],{},[863,1776,1777],{},"rate_limiters.apiTokensLimiters.generalUnionLimiter"," - A ",[863,1780,1781],{},"burstLimiter"," and a ",[863,1784,1785],{},"slowLimiter"," ",[945,1788,1792],{"href":1789,"rel":1790},"https:\u002F\u002Fgithub.com\u002Fanimir\u002Fnode-rate-limiter-flexible\u002Fwiki\u002FRateLimiterUnion",[1791],"nofollow","union limiter",". Enforces no more than one request per second, and only 50 per minute. No Consecutive triggers in this limiter, triggering it again will result in a permanent ban. ",[1795,1796,1797],"strong",{},"It is disabled by default in this endpoint"," and if enabled, it will run on every request and will not be restarted on successful verification.",[1751,1800,1801,1806],{},[1754,1802,1803,1805],{},[863,1804,1781],{}," - Will block the client for 15 minutes.",[1754,1807,1808,1810],{},[863,1809,1785],{}," - Will block for 1 hour.",[890,1812],{},[898,1814,1816],{"id":1815},"using-the-library","Using the library",[856,1818,1819,1820,982],{},"When using the service as a library, you verify tokens with ",[863,1821,882],{},[906,1823,1828],{"className":1824,"code":1825,"filename":1826,"language":1827,"meta":911,"style":911},"language-ts shiki shiki-themes light-plus light-plus dracula","import { verifyApiKey } from '@riavzon\u002Fauth'\n\nconst result = await verifyApiKey(\n  rawKey,\n  false,\n  'restricted',\n  false,\n  false,\n  ipAddress\n)\n\nif (result.ok) {\n  console.log(result.data.name)\n}\n","example.ts","ts",[863,1829,1830,1856,1860,1882,1889,1896,1909,1915,1921,1926,1931,1935,1954,1979],{"__ignoreMap":911},[915,1831,1832,1835,1838,1841,1844,1847,1850,1853],{"class":917,"line":918},[915,1833,1834],{"class":921},"import",[915,1836,1837],{"class":925}," { ",[915,1839,882],{"class":1840},"sjsA6",[915,1842,1843],{"class":925}," } ",[915,1845,1846],{"class":921},"from",[915,1848,1849],{"class":1036}," '",[915,1851,1852],{"class":971},"@riavzon\u002Fauth",[915,1854,1855],{"class":1036},"'\n",[915,1857,1858],{"class":917,"line":975},[915,1859,991],{"emptyLinePlaceholder":8},[915,1861,1862,1865,1869,1872,1875,1879],{"class":917,"line":988},[915,1863,1864],{"class":929},"const",[915,1866,1868],{"class":1867},"s3JHE"," result",[915,1870,1871],{"class":1014}," =",[915,1873,1874],{"class":921}," await",[915,1876,1878],{"class":1877},"sHOzp"," verifyApiKey",[915,1880,1881],{"class":925},"(\n",[915,1883,1884,1887],{"class":917,"line":994},[915,1885,1886],{"class":1840},"  rawKey",[915,1888,1021],{"class":925},[915,1890,1891,1894],{"class":917,"line":1000},[915,1892,1893],{"class":1017},"  false",[915,1895,1021],{"class":925},[915,1897,1898,1901,1904,1907],{"class":917,"line":1024},[915,1899,1900],{"class":1036},"  '",[915,1902,1903],{"class":971},"restricted",[915,1905,1906],{"class":1036},"'",[915,1908,1021],{"class":925},[915,1910,1911,1913],{"class":917,"line":1047},[915,1912,1893],{"class":1017},[915,1914,1021],{"class":925},[915,1916,1917,1919],{"class":917,"line":1062},[915,1918,1893],{"class":1017},[915,1920,1021],{"class":925},[915,1922,1923],{"class":917,"line":1084},[915,1924,1925],{"class":1840},"  ipAddress\n",[915,1927,1928],{"class":917,"line":1101},[915,1929,1930],{"class":925},")\n",[915,1932,1933],{"class":917,"line":1118},[915,1934,991],{"emptyLinePlaceholder":8},[915,1936,1937,1940,1943,1946,1949,1951],{"class":917,"line":1139},[915,1938,1939],{"class":921},"if",[915,1941,1942],{"class":925}," (",[915,1944,1945],{"class":1840},"result",[915,1947,1948],{"class":925},".",[915,1950,1008],{"class":1840},[915,1952,1953],{"class":925},") {\n",[915,1955,1956,1959,1961,1964,1967,1969,1971,1973,1975,1977],{"class":917,"line":1160},[915,1957,1958],{"class":1840},"  console",[915,1960,1948],{"class":925},[915,1962,1963],{"class":1877},"log",[915,1965,1966],{"class":925},"(",[915,1968,1945],{"class":1840},[915,1970,1948],{"class":925},[915,1972,1052],{"class":1840},[915,1974,1948],{"class":925},[915,1976,1068],{"class":1840},[915,1978,1930],{"class":925},[915,1980,1981],{"class":917,"line":1181},[915,1982,1227],{"class":925},[856,1984,1985],{},"The parameters you pass to it, controls the security and configuration of the verification process:",[1229,1987,1989],{"id":1988},"parameters","Parameters",[1991,1992,1993,2009],"table",{},[1994,1995,1996],"thead",{},[1997,1998,1999,2003,2006],"tr",{},[2000,2001,2002],"th",{},"Field",[2000,2004,2005],{},"Type",[2000,2007,2008],{},"Description",[2010,2011,2012,2032,2056,2070,2086,2109],"tbody",{},[1997,2013,2014,2020,2025],{},[2015,2016,2017],"td",{},[863,2018,2019],{},"rawKey",[2015,2021,2022],{},[863,2023,2024],{},"string",[2015,2026,2027,2028,2031],{},"The ",[1765,2029,2030],{},"Raw",", un hashed API token to verify",[1997,2033,2034,2039,2044],{},[2015,2035,2036],{},[863,2037,2038],{},"skipCountUpdates",[2015,2040,2041],{},[863,2042,2043],{},"boolean",[2015,2045,2046,2047,2050,2051,2053,2054],{},"If ",[863,2048,2049],{},"true",", the token is verified without incrementing usage counters ",[863,2052,1186],{}," and ",[863,2055,1165],{},[1997,2057,2058,2062,2067],{},[2015,2059,2060],{},[863,2061,1203],{},[2015,2063,2064],{},[863,2065,2066],{},"demo | restricted | protected | full | custom",[2015,2068,2069],{},"The privilege level that must match the stored token privilege",[1997,2071,2072,2077,2081],{},[2015,2073,2074],{},[863,2075,2076],{},"byPassIpCheck",[2015,2078,2079],{},[863,2080,2043],{},[2015,2082,2046,2083,2085],{},[863,2084,2049],{},", the IP restriction check is skipped",[1997,2087,2088,2093,2097],{},[2015,2089,2090],{},[863,2091,2092],{},"isInternalHash",[2015,2094,2095],{},[863,2096,2043],{},[2015,2098,2046,2099,2101,2102,2105,2106],{},[863,2100,2049],{},", the input is already treated as an ",[1765,2103,2104],{},"internal hash"," skipping checksum and signature verification. Defaults to ",[863,2107,2108],{},"false",[1997,2110,2111,2116,2121],{},[2015,2112,2113],{},[863,2114,2115],{},"ipAddress",[2015,2117,2118],{},[863,2119,2120],{},"string | undefined",[2015,2122,2123],{},"The caller IP address used for restriction checks",[1229,2125,2127],{"id":2126},"signature","Signature",[906,2129,2131],{"className":1824,"code":2130,"language":1827,"meta":911,"style":911},"async function verifyApiKey(\n  rawKey: string,\n  skipCountUpdates: boolean,\n  providedPrivilege: 'demo' | 'restricted' | 'protected' | 'full' | 'custom',\n  byPassIpCheck: boolean,\n  isInternalHash?: boolean,\n  ipAddress?: string\n): Promise\u003CResults\u003CVerifySuccessResponse>>\n",[863,2132,2133,2145,2158,2170,2222,2233,2245,2255],{"__ignoreMap":911},[915,2134,2135,2138,2141,2143],{"class":917,"line":918},[915,2136,2137],{"class":929},"async",[915,2139,2140],{"class":929}," function",[915,2142,1878],{"class":1877},[915,2144,1881],{"class":925},[915,2146,2147,2150,2152,2156],{"class":917,"line":975},[915,2148,1886],{"class":2149},"sygFZ",[915,2151,982],{"class":1014},[915,2153,2155],{"class":2154},"sFs1U"," string",[915,2157,1021],{"class":925},[915,2159,2160,2163,2165,2168],{"class":917,"line":988},[915,2161,2162],{"class":2149},"  skipCountUpdates",[915,2164,982],{"class":1014},[915,2166,2167],{"class":2154}," boolean",[915,2169,1021],{"class":925},[915,2171,2172,2175,2177,2179,2182,2184,2187,2189,2191,2193,2195,2197,2200,2202,2204,2206,2209,2211,2213,2215,2218,2220],{"class":917,"line":994},[915,2173,2174],{"class":2149},"  providedPrivilege",[915,2176,982],{"class":1014},[915,2178,1849],{"class":1036},[915,2180,2181],{"class":971},"demo",[915,2183,1906],{"class":1036},[915,2185,2186],{"class":1014}," |",[915,2188,1849],{"class":1036},[915,2190,1903],{"class":971},[915,2192,1906],{"class":1036},[915,2194,2186],{"class":1014},[915,2196,1849],{"class":1036},[915,2198,2199],{"class":971},"protected",[915,2201,1906],{"class":1036},[915,2203,2186],{"class":1014},[915,2205,1849],{"class":1036},[915,2207,2208],{"class":971},"full",[915,2210,1906],{"class":1036},[915,2212,2186],{"class":1014},[915,2214,1849],{"class":1036},[915,2216,2217],{"class":971},"custom",[915,2219,1906],{"class":1036},[915,2221,1021],{"class":925},[915,2223,2224,2227,2229,2231],{"class":917,"line":1000},[915,2225,2226],{"class":2149},"  byPassIpCheck",[915,2228,982],{"class":1014},[915,2230,2167],{"class":2154},[915,2232,1021],{"class":925},[915,2234,2235,2238,2241,2243],{"class":917,"line":1024},[915,2236,2237],{"class":2149},"  isInternalHash",[915,2239,2240],{"class":1014},"?:",[915,2242,2167],{"class":2154},[915,2244,1021],{"class":925},[915,2246,2247,2250,2252],{"class":917,"line":1047},[915,2248,2249],{"class":2149},"  ipAddress",[915,2251,2240],{"class":1014},[915,2253,2254],{"class":2154}," string\n",[915,2256,2257,2260,2262,2265,2268,2272,2274,2277],{"class":917,"line":1062},[915,2258,2259],{"class":925},")",[915,2261,982],{"class":1014},[915,2263,2264],{"class":2154}," Promise",[915,2266,2267],{"class":925},"\u003C",[915,2269,2271],{"class":2270},"sW-rI","Results",[915,2273,2267],{"class":925},[915,2275,2276],{"class":2270},"VerifySuccessResponse",[915,2278,2279],{"class":925},">>\n",[856,2281,2282],{},"If the verification succeeded, you get back the following object:",[906,2284,2286],{"className":1824,"code":2285,"language":1827,"meta":911,"style":911},"{\n  ok: true,\n  date: new Date().toISOString(),\n  data: {\n      name: 'mytoken',\n      tokenId: 12,\n      userId: 1234,\n      createdAt: \"2026-04-30T10:00:00.000Z\",\n      expiresAt: \"2026-04-30T11:00:00.000Z\",\n      lastUsed: \"2026-04-30T10:12:00.000Z\",\n      usageCount: 1234,\n      providedPrivilege \u002F\u002F Validated privilege\n  }\n}\n",[863,2287,2288,2292,2301,2322,2327,2340,2350,2360,2373,2386,2399,2408,2417,2421],{"__ignoreMap":911},[915,2289,2290],{"class":917,"line":918},[915,2291,997],{"class":925},[915,2293,2294,2297,2299],{"class":917,"line":975},[915,2295,2296],{"class":925},"  ok: ",[915,2298,2049],{"class":1017},[915,2300,1021],{"class":925},[915,2302,2303,2306,2310,2313,2316,2319],{"class":917,"line":988},[915,2304,2305],{"class":925},"  date: ",[915,2307,2309],{"class":2308},"sakC6","new",[915,2311,2312],{"class":1877}," Date",[915,2314,2315],{"class":925},"().",[915,2317,2318],{"class":1877},"toISOString",[915,2320,2321],{"class":925},"(),\n",[915,2323,2324],{"class":917,"line":994},[915,2325,2326],{"class":925},"  data: {\n",[915,2328,2329,2332,2334,2336,2338],{"class":917,"line":1000},[915,2330,2331],{"class":925},"      name: ",[915,2333,1906],{"class":1036},[915,2335,1077],{"class":971},[915,2337,1906],{"class":1036},[915,2339,1021],{"class":925},[915,2341,2342,2345,2348],{"class":917,"line":1024},[915,2343,2344],{"class":925},"      tokenId: ",[915,2346,2347],{"class":936},"12",[915,2349,1021],{"class":925},[915,2351,2352,2355,2358],{"class":917,"line":1047},[915,2353,2354],{"class":925},"      userId: ",[915,2356,2357],{"class":936},"1234",[915,2359,1021],{"class":925},[915,2361,2362,2365,2367,2369,2371],{"class":917,"line":1062},[915,2363,2364],{"class":925},"      createdAt: ",[915,2366,1011],{"class":1036},[915,2368,1132],{"class":971},[915,2370,1011],{"class":1036},[915,2372,1021],{"class":925},[915,2374,2375,2378,2380,2382,2384],{"class":917,"line":1084},[915,2376,2377],{"class":925},"      expiresAt: ",[915,2379,1011],{"class":1036},[915,2381,1153],{"class":971},[915,2383,1011],{"class":1036},[915,2385,1021],{"class":925},[915,2387,2388,2391,2393,2395,2397],{"class":917,"line":1101},[915,2389,2390],{"class":925},"      lastUsed: ",[915,2392,1011],{"class":1036},[915,2394,1174],{"class":971},[915,2396,1011],{"class":1036},[915,2398,1021],{"class":925},[915,2400,2401,2404,2406],{"class":917,"line":1118},[915,2402,2403],{"class":925},"      usageCount: ",[915,2405,2357],{"class":936},[915,2407,1021],{"class":925},[915,2409,2410,2413],{"class":917,"line":1139},[915,2411,2412],{"class":1840},"      providedPrivilege",[915,2414,2416],{"class":2415},"sghk6"," \u002F\u002F Validated privilege\n",[915,2418,2419],{"class":917,"line":1160},[915,2420,1221],{"class":925},[915,2422,2423],{"class":917,"line":1181},[915,2424,1227],{"class":925},[856,2426,2427],{},"In any case the token is invalid, the checksum is invalid, or if the token haves insufficient privileges, you will get the following response:",[906,2429,2431],{"className":1824,"code":2430,"language":1827,"meta":911,"style":911},"{\n ok: false,\n date: new Date().toISOString(),\n reason: 'Invalid key'\n}\n",[863,2432,2433,2437,2446,2461,2472],{"__ignoreMap":911},[915,2434,2435],{"class":917,"line":918},[915,2436,997],{"class":925},[915,2438,2439,2442,2444],{"class":917,"line":975},[915,2440,2441],{"class":925}," ok: ",[915,2443,2108],{"class":1017},[915,2445,1021],{"class":925},[915,2447,2448,2451,2453,2455,2457,2459],{"class":917,"line":988},[915,2449,2450],{"class":925}," date: ",[915,2452,2309],{"class":2308},[915,2454,2312],{"class":1877},[915,2456,2315],{"class":925},[915,2458,2318],{"class":1877},[915,2460,2321],{"class":925},[915,2462,2463,2466,2468,2470],{"class":917,"line":994},[915,2464,2465],{"class":925}," reason: ",[915,2467,1906],{"class":1036},[915,2469,1645],{"class":971},[915,2471,1855],{"class":1036},[915,2473,2474],{"class":917,"line":1000},[915,2475,1227],{"class":925},[856,2477,2478,2479,2481,2482,1948],{},"If ip restrictions is configured the ",[863,2480,1313],{}," will be ",[863,2483,2484],{},"'Invalid Host'",[856,2486,2487,2488,2481,2490,2493,2494,2496,2497,1948],{},"When the token have an expiration date and it expired, the token will be marked as invalid, and can't be used again. In such cases the ",[863,2489,1313],{},[863,2491,2492],{},"\"Token expired\"",". In any case of database errors the ",[863,2495,1313],{}," will result in ",[863,2498,2499],{},"'Server error validating token.'",[856,2501,2502,2503,2506,2507,2510,2511,2514,2515,1948],{},"When debugging or to get more information why may a verification is failing use the ",[945,2504,2505],{"href":144},"Logs"," with a level of ",[863,2508,2509],{},"info"," under the branch of ",[863,2512,2513],{},"branch: 'api_tokens'",", and type of ",[863,2516,2517],{},"type: 'verify'",[890,2519],{},[893,2521,2523],{"id":2522},"verification-process","Verification Process",[856,2525,2526,2527,2529],{},"When a request is made to verify a token, either via the public API route or internally using the ",[863,2528,882],{}," function, the system executes a multi-step validation sequence. This process is designed to reject invalid payloads as fast as possible to save database resources, while ensuring secure, usage tracking for valid keys.",[898,2531,2533],{"id":2532},"fast-validation","Fast Validation",[856,2535,2536],{},"Before touching the database, the system validates the structural integrity of the raw API key.",[1751,2538,2539,2556,2559],{},[1754,2540,2541,2542,2544,2545,2548,2549,2552,2553,1948],{},"Unless the token is explicitly flagged as an internal hash (",[863,2543,2092],{},"), it splits the key into its three components: the ",[1795,2546,2547],{},"prefix",", the ",[1795,2550,2551],{},"random payload",", and the ",[1795,2554,2555],{},"checksum",[1754,2557,2558],{},"If any component is missing, it is immediately rejected.",[1754,2560,2561,2562,2565],{},"The system recalculates the expected checksum from the random payload and performs a ",[1795,2563,2564],{},"timing comparison"," against the provided checksum. If they do not match, the token is counterfeit or corrupted, and the request is aborted.",[898,2567,2569],{"id":2568},"cryptographic-hashing","Cryptographic Hashing",[856,2571,2572,2573,2576],{},"Once the structure is validated, the raw token is hashed with ",[863,2574,2575],{},"sha-256",". The database never compares raw tokens; it interacts with these hashed representations to prevent exposure in the event of a database leak.",[898,2578,2580],{"id":2579},"database-lookup-privilege-check","Database Lookup & Privilege Check",[856,2582,2583,2584,2587],{},"The system opens a database transaction and queries the ",[863,2585,2586],{},"api_tokens"," table for the hashed key.",[1751,2589,2590,2599],{},[1754,2591,2592,2593,2596,2597,1948],{},"It explicitly looks for a token that is actively valid (",[863,2594,2595],{},"valid = 1",") and matches the exact ",[863,2598,1203],{},[1754,2600,2601,2602,2604],{},"If the token does not exist, was previously revoked, or lacks the requested privilege, the transaction is rolled back and the request is rejected with an ",[863,2603,1645],{}," error.",[872,2606,2607],{},[856,2608,2609,2610,2612,2613,2616],{},"Unless ",[863,2611,2038],{}," is enabled, this query uses a ",[863,2614,2615],{},"FOR UPDATE"," lock. This prevents race conditions, ensuring that concurrent requests using the same token safely queue to update the usage counters accurately.",[898,2618,199],{"id":2619},"ip-restriction",[856,2621,2622,2623,2625,2626,2629],{},"If the caller requires IP validation (",[863,2624,2076],{}," is false) and the token owner configured an IP whitelist (",[863,2627,2628],{},"restricted_to_ip_address","):",[1751,2631,2632,2635,2638],{},[1754,2633,2634],{},"The system verifies that an IP address was actually provided in the request.",[1754,2636,2637],{},"It checks if the provided IP exists within the token's configured whitelist array.",[1754,2639,2640,2641,2604],{},"If either check fails, the transaction is rolled back, and the system logs an unauthorized access attempt, returning an ",[863,2642,2643],{},"Invalid Host",[898,2645,2647],{"id":2646},"expiration","Expiration",[856,2649,2650,2651,2654],{},"The system checks if the token has an ",[863,2652,2653],{},"expires_at"," timestamp.",[1751,2656,2657,2664],{},[1754,2658,2659,2660,2663],{},"If an expiration date exists and the current time has surpassed it, the token is permanently invalidated in the database (",[863,2661,2662],{},"valid = 0",").",[1754,2665,2666,2667,2670],{},"The system commits this invalidation state, logs the expiration, and returns a ",[863,2668,2669],{},"Token expired"," error to the caller.",[898,2672,2674],{"id":2673},"usage-tracking-metadata","Usage Tracking & Metadata",[856,2676,2677],{},"If the token successfully passes all security, network, and lifecycle checks:",[1751,2679,2680,2697,2700],{},[1754,2681,2609,2682,2684,2685,2688,2689,2692,2693,2696],{},[863,2683,2038],{}," is active, the system increments the token's ",[863,2686,2687],{},"usage_count"," by 1 and updates the ",[863,2690,2691],{},"last_used"," timestamp to the current ",[1765,2694,2695],{},"UTC"," time.",[1754,2698,2699],{},"The transaction is committed.",[1754,2701,2702],{},"A success payload described above, is returned to the caller, containing rich metadata about the token, including its configured name, internal IDs, and current usage metrics.",[890,2704],{},[893,2706,2708],{"id":2707},"references","References",[898,2710,237],{"id":2711},"configuration",[856,2713,2714,2715,2053,2718,2721,2722,1948],{},"All verification behavior is controlled under ",[863,2716,2717],{},"apiTokens",[863,2719,2720],{},"rate_limiters.apiTokensLimiters"," in the configuration passed to ",[863,2723,2724],{},"configuration()",[898,2726,2728],{"id":2727},"apitokens",[863,2729,2717],{},[1991,2731,2732,2746],{},[1994,2733,2734],{},[1997,2735,2736,2739,2741,2744],{},[2000,2737,2738],{},"Option",[2000,2740,2005],{},[2000,2742,2743],{},"Default",[2000,2745,2008],{},[2010,2747,2748],{},[1997,2749,2750,2755,2759,2763],{},[2015,2751,2752],{},[863,2753,2754],{},"rateLimitOnSuccessfulRequest",[2015,2756,2757],{},[863,2758,2043],{},[2015,2760,2761],{},[863,2762,2108],{},[2015,2764,2765],{},"When enabled, successful verification requests consume the general limiter",[898,2767,2769],{"id":2768},"rate-limiters","Rate limiters",[1991,2771,2772,2781],{},[1994,2773,2774],{},[1997,2775,2776,2779],{},[2000,2777,2778],{},"Limiter",[2000,2780,2008],{},[2010,2782,2783,2796],{},[1997,2784,2785,2789],{},[2015,2786,2787],{},[863,2788,1758],{},[2015,2790,2791,2792,2795],{},"The main rate limiter for token verification, that limits ",[1765,2793,2794],{},"only"," failed attempts",[1997,2797,2798,2802],{},[2015,2799,2800],{},[863,2801,1777],{},[2015,2803,2804,2805],{},"General burst limiter, that if enabled, will run on ",[1765,2806,2807],{},"every request",[890,2809],{},[898,2811,2813],{"id":2812},"metadata-returned-on-success","Metadata returned on success",[1991,2815,2816,2824],{},[1994,2817,2818],{},[1997,2819,2820,2822],{},[2000,2821,2002],{},[2000,2823,2008],{},[2010,2825,2826,2835,2844,2853,2862,2871,2880,2889],{},[1997,2827,2828,2832],{},[2015,2829,2830],{},[863,2831,1068],{},[2015,2833,2834],{},"Friendly token name defined in the creation step",[1997,2836,2837,2841],{},[2015,2838,2839],{},[863,2840,1089],{},[2015,2842,2843],{},"Database identifier",[1997,2845,2846,2850],{},[2015,2847,2848],{},[863,2849,1106],{},[2015,2851,2852],{},"Owner of the token",[1997,2854,2855,2859],{},[2015,2856,2857],{},[863,2858,1123],{},[2015,2860,2861],{},"Creation timestamp",[1997,2863,2864,2868],{},[2015,2865,2866],{},[863,2867,1144],{},[2015,2869,2870],{},"Expiration timestamp, if set",[1997,2872,2873,2877],{},[2015,2874,2875],{},[863,2876,1165],{},[2015,2878,2879],{},"Last successful usage time",[1997,2881,2882,2886],{},[2015,2883,2884],{},[863,2885,1186],{},[2015,2887,2888],{},"Number of successful uses",[1997,2890,2891,2895],{},[2015,2892,2893],{},[863,2894,1203],{},[2015,2896,2897],{},"Privilege level that was verified",[890,2899],{},[2901,2902,2903],"style",{},"html pre.shiki code .sZ328, html code.shiki .sZ328{--shiki-light:#AF00DB;--shiki-default:#AF00DB;--shiki-dark:#FF79C6}html pre.shiki code .sDd4n, html code.shiki .sDd4n{--shiki-light:#000000;--shiki-default:#000000;--shiki-dark:#F8F8F2}html pre.shiki code .sl46w, html code.shiki .sl46w{--shiki-light:#0000FF;--shiki-default:#0000FF;--shiki-dark:#FF79C6}html pre.shiki code .spgvN, html code.shiki .spgvN{--shiki-light:#098658;--shiki-default:#098658;--shiki-dark:#BD93F9}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sFB1V, html code.shiki .sFB1V{--shiki-light:#A31515;--shiki-default:#A31515;--shiki-dark:#F1FA8C}html pre.shiki code .scd-l, html code.shiki .scd-l{--shiki-light:#800000;--shiki-default:#800000;--shiki-dark:#FF79C6}html pre.shiki code .saJyd, html code.shiki .saJyd{--shiki-light:#0451A5;--shiki-default:#0451A5;--shiki-dark:#8BE9FE}html pre.shiki code .s_W10, html code.shiki .s_W10{--shiki-light:#0451A5;--shiki-default:#0451A5;--shiki-dark:#8BE9FD}html pre.shiki code .saOXh, html code.shiki .saOXh{--shiki-light:#000000;--shiki-default:#000000;--shiki-dark:#FF79C6}html pre.shiki code .sjR7W, html code.shiki .sjR7W{--shiki-light:#0000FF;--shiki-default:#0000FF;--shiki-dark:#BD93F9}html pre.shiki code .sFkSl, html code.shiki .sFkSl{--shiki-light:#A31515;--shiki-default:#A31515;--shiki-dark:#E9F284}html pre.shiki code .sjsA6, html code.shiki .sjsA6{--shiki-light:#001080;--shiki-default:#001080;--shiki-dark:#F8F8F2}html pre.shiki code .s3JHE, html code.shiki .s3JHE{--shiki-light:#0070C1;--shiki-default:#0070C1;--shiki-dark:#F8F8F2}html pre.shiki code .sHOzp, html code.shiki .sHOzp{--shiki-light:#795E26;--shiki-default:#795E26;--shiki-dark:#50FA7B}html pre.shiki code .sygFZ, html code.shiki .sygFZ{--shiki-light:#001080;--shiki-light-font-style:inherit;--shiki-default:#001080;--shiki-default-font-style:inherit;--shiki-dark:#FFB86C;--shiki-dark-font-style:italic}html pre.shiki code .sFs1U, html code.shiki .sFs1U{--shiki-light:#267F99;--shiki-light-font-style:inherit;--shiki-default:#267F99;--shiki-default-font-style:inherit;--shiki-dark:#8BE9FD;--shiki-dark-font-style:italic}html pre.shiki code .sW-rI, html code.shiki .sW-rI{--shiki-light:#267F99;--shiki-light-font-style:inherit;--shiki-default:#267F99;--shiki-default-font-style:inherit;--shiki-dark:#FFB86C;--shiki-dark-font-style:italic}html pre.shiki code .sakC6, html code.shiki .sakC6{--shiki-light:#0000FF;--shiki-light-font-weight:inherit;--shiki-default:#0000FF;--shiki-default-font-weight:inherit;--shiki-dark:#FF79C6;--shiki-dark-font-weight:bold}html pre.shiki code .sghk6, html code.shiki .sghk6{--shiki-light:#008000;--shiki-default:#008000;--shiki-dark:#6272A4}",{"title":911,"searchDepth":975,"depth":975,"links":2905},[2906,2910,2918],{"id":895,"depth":975,"text":896,"children":2907},[2908,2909],{"id":900,"depth":988,"text":901},{"id":1815,"depth":988,"text":1816},{"id":2522,"depth":975,"text":2523,"children":2911},[2912,2913,2914,2915,2916,2917],{"id":2532,"depth":988,"text":2533},{"id":2568,"depth":988,"text":2569},{"id":2579,"depth":988,"text":2580},{"id":2619,"depth":988,"text":199},{"id":2646,"depth":988,"text":2647},{"id":2673,"depth":988,"text":2674},{"id":2707,"depth":975,"text":2708,"children":2919},[2920,2921,2922,2923],{"id":2711,"depth":988,"text":237},{"id":2727,"depth":988,"text":2717},{"id":2768,"depth":988,"text":2769},{"id":2812,"depth":988,"text":2813},"How to verify API tokens, enforce privilege scopes, apply IP restrictions, and handle rate-limited verification.","md","i-lucide-check-circle",{},null,"---\ntitle: Verifying Tokens\ndescription: How to verify API tokens, enforce privilege scopes, apply IP restrictions, and handle rate-limited verification.\nicon: i-lucide-check-circle\n---\n\nAPI token verification is the public M2M entry point for validating a token against the IAM and checking if it is allowed to perform a given privilege.\n\nIf using the service a caller must send the raw API key in the `x-api-key` header and request a privilege scope through the `privilege` query parameter. The service then validates the token structure.\n\n::note\nThe endpoint is not behind any authentication flow, MFA's or bot detections, it verify the given token and gets out of the way.\n::\n\nIf using the library, you call `verifyApiKey` with the appropriate parameters, depending on your needs and use case.\n\n::note\nThe token will be verified against the attributes you defined in the creation step\n::\n\n---\n\n## Verifying a token\n\n### Using the route\n\nThe verification route is available at:\n\n```http\nGET \u002Fapi\u002Fpublic\u002Fverify?privilege=\u003Cprivilege> HTTP\u002F1.1\n```\nSend the token in the `x-api-key` header with the privilege you defined at the [creation step](\u002Fdocs\u002Fiam\u002Fessentials\u002Fapi\u002Fcreation) of the token.\n\nOn success the response will be:\n\n```http\nHTTP\u002F1.1 200 OK\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": true,\n  \"date\": \"current date\",\n  \"data\": {\n    \"name\": \"mytoken\",\n    \"tokenId\": 12,\n    \"userId\": 42,\n    \"createdAt\": \"2026-04-30T10:00:00.000Z\",\n    \"expiresAt\": \"2026-04-30T11:00:00.000Z\",\n    \"lastUsed\": \"2026-04-30T10:12:00.000Z\",\n    \"usageCount\": 7,\n    \"providedPrivilege\": \"verified privilege\"\n  }\n}\n```\n#### Failed responses\n\nIf the `x-api-key` header is missing or malformed, the route returns:\n\n```http\nHTTP\u002F1.1 401 Unauthorized\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": false,\n  \"date\": \"current date\",\n  \"reason\": \"No api key provided\"\n}\n```\n\nIf the server cannot resolve the caller IP, the route returns:\n\n```http\nHTTP\u002F1.1 400 Bad Request\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": false,\n  \"date\": \"current date\",\n  \"reason\": \"Bad Request\"\n}\n```\n\nIf the query parameter does not match the allowed privilege schema, the route returns:\n\n```http\nHTTP\u002F1.1 400 Bad Request\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": false,\n  \"date\": \"current date\",\n  \"reason\": \"Bad Request\"\n}\n```\n\nThe input is detected as an XSS attempt, the service bans the request:\n\n```http\nHTTP\u002F1.1 403 Forbidden\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"banned\": true\n}\n```\n\nThe token is malformed, expired, revoked, missing, or has the wrong privilege, the route returns:\n\n```http\nHTTP\u002F1.1 401 Unauthorized\nContent-Type: application\u002Fjson; charset=utf-8\n\n{\n  \"ok\": false,\n  \"date\": \"current date\",\n  \"reason\": \"Invalid key\"\n}\n```\n\nRate limits:\n```http\nHTTP\u002F1.1 429\nContent-Type: application\u002Fjson; charset=utf-8\nRetry-After: number\n{\n  \"error\": \"Too many requests\",\n  \"retry\": \"number\",\n}\n```\n\n::caution\nThis endpoint is designed for machine-to-machine use. Do not expose raw API keys in client-side code unless the client is fully trusted and isolated from users.\n::\n\n#### Rate limits\n\nThe route is not behind any authentication or middlewares. its protected solely by rate limiters that differentiate between \"probing\" (failures) and \"usage\" (success):\n\n- `rate_limiters.apiTokensLimiters.consumptionRateLimiter` - The main limiter for the failure mode. It will consume a `point` on *Every* failed attempt of verification. On success it will be restarted, which means the client, whose not been rate limited by it, could continue send *valid* verified requests. The limiter enforces 10 requests in a 1 minute window, that will ban for 1 hour if this threshold is reached. No consecutive attempts is provided, which means violating this rule will result in a permanent ban.\n\n\n- `rate_limiters.apiTokensLimiters.generalUnionLimiter` - A `burstLimiter` and a `slowLimiter` [union limiter](https:\u002F\u002Fgithub.com\u002Fanimir\u002Fnode-rate-limiter-flexible\u002Fwiki\u002FRateLimiterUnion). Enforces no more than one request per second, and only 50 per minute. No Consecutive triggers in this limiter, triggering it again will result in a permanent ban. **It is disabled by default in this endpoint** and if enabled, it will run on every request and will not be restarted on successful verification.\n   - `burstLimiter` - Will block the client for 15 minutes.\n   - `slowLimiter` - Will block for 1 hour.\n\n\n---\n\n### Using the library\n\nWhen using the service as a library, you verify tokens with `verifyApiKey`:\n\n```ts [example.ts]\nimport { verifyApiKey } from '@riavzon\u002Fauth'\n\nconst result = await verifyApiKey(\n  rawKey,\n  false,\n  'restricted',\n  false,\n  false,\n  ipAddress\n)\n\nif (result.ok) {\n  console.log(result.data.name)\n}\n```\n\nThe parameters you pass to it, controls the security and configuration of the verification process:\n\n#### Parameters\n\n| Field | Type | Description |\n|---|---|---|\n| `rawKey` | `string` | The *Raw*, un hashed API token to verify |\n| `skipCountUpdates` | `boolean` | If `true`, the token is verified without incrementing usage counters `usageCount` and `lastUsed` |\n| `providedPrivilege` | `demo \\| restricted \\| protected \\| full \\| custom` | The privilege level that must match the stored token privilege |\n| `byPassIpCheck` | `boolean` | If `true`, the IP restriction check is skipped |\n| `isInternalHash` | `boolean` | If `true`, the input is already treated as an *internal hash* skipping checksum and signature verification. Defaults to `false`  |\n| `ipAddress` | `string \\| undefined` | The caller IP address used for restriction checks |\n\n\n#### Signature\n\n```ts\nasync function verifyApiKey(\n  rawKey: string,\n  skipCountUpdates: boolean,\n  providedPrivilege: 'demo' | 'restricted' | 'protected' | 'full' | 'custom',\n  byPassIpCheck: boolean,\n  isInternalHash?: boolean,\n  ipAddress?: string\n): Promise\u003CResults\u003CVerifySuccessResponse>>\n```\nIf the verification succeeded, you get back the following object:\n\n```ts\n{\n  ok: true,\n  date: new Date().toISOString(),\n  data: {\n      name: 'mytoken',\n      tokenId: 12,\n      userId: 1234,\n      createdAt: \"2026-04-30T10:00:00.000Z\",\n      expiresAt: \"2026-04-30T11:00:00.000Z\",\n      lastUsed: \"2026-04-30T10:12:00.000Z\",\n      usageCount: 1234,\n      providedPrivilege \u002F\u002F Validated privilege\n  }\n}\n```\nIn any case the token is invalid, the checksum is invalid, or if the token haves insufficient privileges, you will get the following response:\n\n```ts\n{\n ok: false,\n date: new Date().toISOString(),\n reason: 'Invalid key'\n}\n```\nIf ip restrictions is configured the `reason` will be `'Invalid Host'`.\n\nWhen the token have an expiration date and it expired, the token will be marked as invalid, and can't be used again. In such cases the `reason` will be `\"Token expired\"`. In any case of database errors the `reason` will result in `'Server error validating token.'`.\n\nWhen debugging or to get more information why may a verification is failing use the [Logs](\u002Fdocs\u002Fiam\u002Fessentials\u002Flogging) with a level of `info` under the branch of `branch: 'api_tokens'`, and type of `type: 'verify'`.\n\n---\n\n## Verification Process\n\nWhen a request is made to verify a token, either via the public API route or internally using the `verifyApiKey` function, the system executes a multi-step validation sequence. This process is designed to reject invalid payloads as fast as possible to save database resources, while ensuring secure, usage tracking for valid keys.\n\n### Fast Validation\nBefore touching the database, the system validates the structural integrity of the raw API key. \n\n* Unless the token is explicitly flagged as an internal hash (`isInternalHash`), it splits the key into its three components: the **prefix**, the **random payload**, and the **checksum**.\n\n* If any component is missing, it is immediately rejected.\n\n* The system recalculates the expected checksum from the random payload and performs a **timing comparison** against the provided checksum. If they do not match, the token is counterfeit or corrupted, and the request is aborted.\n\n### Cryptographic Hashing\nOnce the structure is validated, the raw token is hashed with `sha-256`. The database never compares raw tokens; it interacts with these hashed representations to prevent exposure in the event of a database leak.\n\n### Database Lookup & Privilege Check\nThe system opens a database transaction and queries the `api_tokens` table for the hashed key. \n* It explicitly looks for a token that is actively valid (`valid = 1`) and matches the exact `providedPrivilege`. \n* If the token does not exist, was previously revoked, or lacks the requested privilege, the transaction is rolled back and the request is rejected with an `Invalid key` error.\n\n::note\nUnless `skipCountUpdates` is enabled, this query uses a `FOR UPDATE` lock. This prevents race conditions, ensuring that concurrent requests using the same token safely queue to update the usage counters accurately.\n::\n\n### IP Restriction\nIf the caller requires IP validation (`byPassIpCheck` is false) and the token owner configured an IP whitelist (`restricted_to_ip_address`):\n* The system verifies that an IP address was actually provided in the request.\n* It checks if the provided IP exists within the token's configured whitelist array.\n* If either check fails, the transaction is rolled back, and the system logs an unauthorized access attempt, returning an `Invalid Host` error.\n\n### Expiration\nThe system checks if the token has an `expires_at` timestamp.\n* If an expiration date exists and the current time has surpassed it, the token is permanently invalidated in the database (`valid = 0`). \n* The system commits this invalidation state, logs the expiration, and returns a `Token expired` error to the caller.\n\n### Usage Tracking & Metadata\nIf the token successfully passes all security, network, and lifecycle checks:\n* Unless `skipCountUpdates` is active, the system increments the token's `usage_count` by 1 and updates the `last_used` timestamp to the current *UTC* time.\n* The transaction is committed.\n* A success payload described above, is returned to the caller, containing rich metadata about the token, including its configured name, internal IDs, and current usage metrics. \n\n---\n\n## References\n\n### Configuration \nAll verification behavior is controlled under `apiTokens` and `rate_limiters.apiTokensLimiters` in the configuration passed to `configuration()`.\n\n### `apiTokens`\n\n| Option | Type | Default | Description |\n|---|---|---|---|\n| `rateLimitOnSuccessfulRequest` | `boolean` | `false` | When enabled, successful verification requests consume the general limiter |\n\n\n### Rate limiters\n| Limiter | Description |\n|---|---|\n| `rate_limiters.apiTokensLimiters.consumptionRateLimiter` | The main rate limiter for token verification, that limits *only* failed attempts |\n| `rate_limiters.apiTokensLimiters.generalUnionLimiter` | General burst limiter, that if enabled, will run on *every request* |\n\n---\n\n### Metadata returned on success\n\n| Field | Description |\n|---|---|\n| `name` | Friendly token name defined in the creation step |\n| `tokenId` | Database identifier |\n| `userId` | Owner of the token |\n| `createdAt` | Creation timestamp |\n| `expiresAt` | Expiration timestamp, if set |\n| `lastUsed` | Last successful usage time |\n| `usageCount` | Number of successful uses |\n| `providedPrivilege` | Privilege level that was verified |\n\n---\n\n\n",{"title":177,"description":2924},"C_XTrerfo4s4pI5MEwrsqFnROYYEE7QxdLOLnAqhqNo",[2933,2934],{"title":173,"path":174,"stem":175,"children":-1},{"title":181,"path":182,"stem":183,"children":-1},{"id":851,"title":177,"body":2936,"description":2924,"extension":2925,"icon":2926,"meta":4587,"module":2928,"navigation":8,"path":178,"rawbody":2929,"seo":4588,"stem":179,"__hash__":2931},{"type":853,"value":2937,"toc":4567},[2938,2940,2946,2950,2954,2958,2960,2962,2964,2966,2982,2988,2990,3204,3206,3210,3294,3296,3380,3382,3466,3468,3516,3518,3602,3604,3678,3682,3684,3686,3721,3723,3725,3729,3855,3857,3859,3961,3963,4089,4091,4211,4213,4257,4263,4273,4283,4285,4287,4291,4293,4295,4313,4315,4319,4321,4325,4337,4345,4347,4353,4363,4365,4369,4379,4381,4383,4399,4401,4403,4405,4413,4417,4449,4451,4483,4485,4487,4563,4565],[856,2939,858],{},[856,2941,861,2942,866,2944,870],{},[863,2943,865],{},[863,2945,869],{},[872,2947,2948],{},[856,2949,876],{},[856,2951,879,2952,883],{},[863,2953,882],{},[872,2955,2956],{},[856,2957,888],{},[890,2959],{},[893,2961,896],{"id":895},[898,2963,901],{"id":900},[856,2965,904],{},[906,2967,2968],{"className":908,"code":909,"language":910,"meta":911,"style":911},[863,2969,2970],{"__ignoreMap":911},[915,2971,2972,2974,2976,2978,2980],{"class":917,"line":918},[915,2973,922],{"class":921},[915,2975,926],{"class":925},[915,2977,930],{"class":929},[915,2979,933],{"class":925},[915,2981,937],{"class":936},[856,2983,940,2984,943,2986,948],{},[863,2985,865],{},[945,2987,947],{"href":174},[856,2989,951],{},[906,2991,2992],{"className":908,"code":954,"language":910,"meta":911,"style":911},[863,2993,2994,3006,3014,3018,3022,3036,3054,3066,3084,3098,3112,3130,3148,3166,3180,3196,3200],{"__ignoreMap":911},[915,2995,2996,2998,3000,3002,3004],{"class":917,"line":918},[915,2997,930],{"class":929},[915,2999,933],{"class":925},[915,3001,965],{"class":936},[915,3003,968],{"class":936},[915,3005,972],{"class":971},[915,3007,3008,3010,3012],{"class":917,"line":975},[915,3009,979],{"class":978},[915,3011,982],{"class":929},[915,3013,985],{"class":971},[915,3015,3016],{"class":917,"line":988},[915,3017,991],{"emptyLinePlaceholder":8},[915,3019,3020],{"class":917,"line":994},[915,3021,997],{"class":925},[915,3023,3024,3026,3028,3030,3032,3034],{"class":917,"line":1000},[915,3025,1004],{"class":1003},[915,3027,1008],{"class":1007},[915,3029,1011],{"class":1003},[915,3031,982],{"class":1014},[915,3033,1018],{"class":1017},[915,3035,1021],{"class":925},[915,3037,3038,3040,3042,3044,3046,3048,3050,3052],{"class":917,"line":1024},[915,3039,1004],{"class":1003},[915,3041,1029],{"class":1007},[915,3043,1011],{"class":1003},[915,3045,982],{"class":1014},[915,3047,1037],{"class":1036},[915,3049,1040],{"class":971},[915,3051,1011],{"class":1036},[915,3053,1021],{"class":925},[915,3055,3056,3058,3060,3062,3064],{"class":917,"line":1047},[915,3057,1004],{"class":1003},[915,3059,1052],{"class":1007},[915,3061,1011],{"class":1003},[915,3063,982],{"class":1014},[915,3065,1059],{"class":925},[915,3067,3068,3070,3072,3074,3076,3078,3080,3082],{"class":917,"line":1062},[915,3069,1065],{"class":1003},[915,3071,1068],{"class":1007},[915,3073,1011],{"class":1003},[915,3075,982],{"class":1014},[915,3077,1037],{"class":1036},[915,3079,1077],{"class":971},[915,3081,1011],{"class":1036},[915,3083,1021],{"class":925},[915,3085,3086,3088,3090,3092,3094,3096],{"class":917,"line":1084},[915,3087,1065],{"class":1003},[915,3089,1089],{"class":1007},[915,3091,1011],{"class":1003},[915,3093,982],{"class":1014},[915,3095,1096],{"class":936},[915,3097,1021],{"class":925},[915,3099,3100,3102,3104,3106,3108,3110],{"class":917,"line":1101},[915,3101,1065],{"class":1003},[915,3103,1106],{"class":1007},[915,3105,1011],{"class":1003},[915,3107,982],{"class":1014},[915,3109,1113],{"class":936},[915,3111,1021],{"class":925},[915,3113,3114,3116,3118,3120,3122,3124,3126,3128],{"class":917,"line":1118},[915,3115,1065],{"class":1003},[915,3117,1123],{"class":1007},[915,3119,1011],{"class":1003},[915,3121,982],{"class":1014},[915,3123,1037],{"class":1036},[915,3125,1132],{"class":971},[915,3127,1011],{"class":1036},[915,3129,1021],{"class":925},[915,3131,3132,3134,3136,3138,3140,3142,3144,3146],{"class":917,"line":1139},[915,3133,1065],{"class":1003},[915,3135,1144],{"class":1007},[915,3137,1011],{"class":1003},[915,3139,982],{"class":1014},[915,3141,1037],{"class":1036},[915,3143,1153],{"class":971},[915,3145,1011],{"class":1036},[915,3147,1021],{"class":925},[915,3149,3150,3152,3154,3156,3158,3160,3162,3164],{"class":917,"line":1160},[915,3151,1065],{"class":1003},[915,3153,1165],{"class":1007},[915,3155,1011],{"class":1003},[915,3157,982],{"class":1014},[915,3159,1037],{"class":1036},[915,3161,1174],{"class":971},[915,3163,1011],{"class":1036},[915,3165,1021],{"class":925},[915,3167,3168,3170,3172,3174,3176,3178],{"class":917,"line":1181},[915,3169,1065],{"class":1003},[915,3171,1186],{"class":1007},[915,3173,1011],{"class":1003},[915,3175,982],{"class":1014},[915,3177,1193],{"class":936},[915,3179,1021],{"class":925},[915,3181,3182,3184,3186,3188,3190,3192,3194],{"class":917,"line":1198},[915,3183,1065],{"class":1003},[915,3185,1203],{"class":1007},[915,3187,1011],{"class":1003},[915,3189,982],{"class":1014},[915,3191,1037],{"class":1036},[915,3193,1212],{"class":971},[915,3195,1215],{"class":1036},[915,3197,3198],{"class":917,"line":1218},[915,3199,1221],{"class":925},[915,3201,3202],{"class":917,"line":1224},[915,3203,1227],{"class":925},[1229,3205,1232],{"id":1231},[856,3207,1235,3208,1238],{},[863,3209,865],{},[906,3211,3212],{"className":908,"code":1241,"language":910,"meta":911,"style":911},[863,3213,3214,3226,3234,3238,3242,3256,3274,3290],{"__ignoreMap":911},[915,3215,3216,3218,3220,3222,3224],{"class":917,"line":918},[915,3217,930],{"class":929},[915,3219,933],{"class":925},[915,3221,965],{"class":936},[915,3223,1254],{"class":936},[915,3225,1257],{"class":971},[915,3227,3228,3230,3232],{"class":917,"line":975},[915,3229,979],{"class":978},[915,3231,982],{"class":929},[915,3233,985],{"class":971},[915,3235,3236],{"class":917,"line":988},[915,3237,991],{"emptyLinePlaceholder":8},[915,3239,3240],{"class":917,"line":994},[915,3241,997],{"class":925},[915,3243,3244,3246,3248,3250,3252,3254],{"class":917,"line":1000},[915,3245,1004],{"class":1003},[915,3247,1008],{"class":1007},[915,3249,1011],{"class":1003},[915,3251,982],{"class":1014},[915,3253,1286],{"class":1017},[915,3255,1021],{"class":925},[915,3257,3258,3260,3262,3264,3266,3268,3270,3272],{"class":917,"line":1024},[915,3259,1004],{"class":1003},[915,3261,1029],{"class":1007},[915,3263,1011],{"class":1003},[915,3265,982],{"class":1014},[915,3267,1037],{"class":1036},[915,3269,1040],{"class":971},[915,3271,1011],{"class":1036},[915,3273,1021],{"class":925},[915,3275,3276,3278,3280,3282,3284,3286,3288],{"class":917,"line":1047},[915,3277,1004],{"class":1003},[915,3279,1313],{"class":1007},[915,3281,1011],{"class":1003},[915,3283,982],{"class":1014},[915,3285,1037],{"class":1036},[915,3287,1322],{"class":971},[915,3289,1215],{"class":1036},[915,3291,3292],{"class":917,"line":1062},[915,3293,1227],{"class":925},[856,3295,1331],{},[906,3297,3298],{"className":908,"code":1334,"language":910,"meta":911,"style":911},[863,3299,3300,3312,3320,3324,3328,3342,3360,3376],{"__ignoreMap":911},[915,3301,3302,3304,3306,3308,3310],{"class":917,"line":918},[915,3303,930],{"class":929},[915,3305,933],{"class":925},[915,3307,965],{"class":936},[915,3309,1347],{"class":936},[915,3311,1350],{"class":971},[915,3313,3314,3316,3318],{"class":917,"line":975},[915,3315,979],{"class":978},[915,3317,982],{"class":929},[915,3319,985],{"class":971},[915,3321,3322],{"class":917,"line":988},[915,3323,991],{"emptyLinePlaceholder":8},[915,3325,3326],{"class":917,"line":994},[915,3327,997],{"class":925},[915,3329,3330,3332,3334,3336,3338,3340],{"class":917,"line":1000},[915,3331,1004],{"class":1003},[915,3333,1008],{"class":1007},[915,3335,1011],{"class":1003},[915,3337,982],{"class":1014},[915,3339,1286],{"class":1017},[915,3341,1021],{"class":925},[915,3343,3344,3346,3348,3350,3352,3354,3356,3358],{"class":917,"line":1024},[915,3345,1004],{"class":1003},[915,3347,1029],{"class":1007},[915,3349,1011],{"class":1003},[915,3351,982],{"class":1014},[915,3353,1037],{"class":1036},[915,3355,1040],{"class":971},[915,3357,1011],{"class":1036},[915,3359,1021],{"class":925},[915,3361,3362,3364,3366,3368,3370,3372,3374],{"class":917,"line":1047},[915,3363,1004],{"class":1003},[915,3365,1313],{"class":1007},[915,3367,1011],{"class":1003},[915,3369,982],{"class":1014},[915,3371,1037],{"class":1036},[915,3373,1413],{"class":971},[915,3375,1215],{"class":1036},[915,3377,3378],{"class":917,"line":1062},[915,3379,1227],{"class":925},[856,3381,1422],{},[906,3383,3384],{"className":908,"code":1334,"language":910,"meta":911,"style":911},[863,3385,3386,3398,3406,3410,3414,3428,3446,3462],{"__ignoreMap":911},[915,3387,3388,3390,3392,3394,3396],{"class":917,"line":918},[915,3389,930],{"class":929},[915,3391,933],{"class":925},[915,3393,965],{"class":936},[915,3395,1347],{"class":936},[915,3397,1350],{"class":971},[915,3399,3400,3402,3404],{"class":917,"line":975},[915,3401,979],{"class":978},[915,3403,982],{"class":929},[915,3405,985],{"class":971},[915,3407,3408],{"class":917,"line":988},[915,3409,991],{"emptyLinePlaceholder":8},[915,3411,3412],{"class":917,"line":994},[915,3413,997],{"class":925},[915,3415,3416,3418,3420,3422,3424,3426],{"class":917,"line":1000},[915,3417,1004],{"class":1003},[915,3419,1008],{"class":1007},[915,3421,1011],{"class":1003},[915,3423,982],{"class":1014},[915,3425,1286],{"class":1017},[915,3427,1021],{"class":925},[915,3429,3430,3432,3434,3436,3438,3440,3442,3444],{"class":917,"line":1024},[915,3431,1004],{"class":1003},[915,3433,1029],{"class":1007},[915,3435,1011],{"class":1003},[915,3437,982],{"class":1014},[915,3439,1037],{"class":1036},[915,3441,1040],{"class":971},[915,3443,1011],{"class":1036},[915,3445,1021],{"class":925},[915,3447,3448,3450,3452,3454,3456,3458,3460],{"class":917,"line":1047},[915,3449,1004],{"class":1003},[915,3451,1313],{"class":1007},[915,3453,1011],{"class":1003},[915,3455,982],{"class":1014},[915,3457,1037],{"class":1036},[915,3459,1413],{"class":971},[915,3461,1215],{"class":1036},[915,3463,3464],{"class":917,"line":1062},[915,3465,1227],{"class":925},[856,3467,1509],{},[906,3469,3470],{"className":908,"code":1512,"language":910,"meta":911,"style":911},[863,3471,3472,3484,3492,3496,3500,3512],{"__ignoreMap":911},[915,3473,3474,3476,3478,3480,3482],{"class":917,"line":918},[915,3475,930],{"class":929},[915,3477,933],{"class":925},[915,3479,965],{"class":936},[915,3481,1525],{"class":936},[915,3483,1528],{"class":971},[915,3485,3486,3488,3490],{"class":917,"line":975},[915,3487,979],{"class":978},[915,3489,982],{"class":929},[915,3491,985],{"class":971},[915,3493,3494],{"class":917,"line":988},[915,3495,991],{"emptyLinePlaceholder":8},[915,3497,3498],{"class":917,"line":994},[915,3499,997],{"class":925},[915,3501,3502,3504,3506,3508,3510],{"class":917,"line":1000},[915,3503,1004],{"class":1003},[915,3505,1551],{"class":1007},[915,3507,1011],{"class":1003},[915,3509,982],{"class":1014},[915,3511,1558],{"class":1017},[915,3513,3514],{"class":917,"line":1024},[915,3515,1227],{"class":925},[856,3517,1565],{},[906,3519,3520],{"className":908,"code":1568,"language":910,"meta":911,"style":911},[863,3521,3522,3534,3542,3546,3550,3564,3582,3598],{"__ignoreMap":911},[915,3523,3524,3526,3528,3530,3532],{"class":917,"line":918},[915,3525,930],{"class":929},[915,3527,933],{"class":925},[915,3529,965],{"class":936},[915,3531,1254],{"class":936},[915,3533,1257],{"class":971},[915,3535,3536,3538,3540],{"class":917,"line":975},[915,3537,979],{"class":978},[915,3539,982],{"class":929},[915,3541,985],{"class":971},[915,3543,3544],{"class":917,"line":988},[915,3545,991],{"emptyLinePlaceholder":8},[915,3547,3548],{"class":917,"line":994},[915,3549,997],{"class":925},[915,3551,3552,3554,3556,3558,3560,3562],{"class":917,"line":1000},[915,3553,1004],{"class":1003},[915,3555,1008],{"class":1007},[915,3557,1011],{"class":1003},[915,3559,982],{"class":1014},[915,3561,1286],{"class":1017},[915,3563,1021],{"class":925},[915,3565,3566,3568,3570,3572,3574,3576,3578,3580],{"class":917,"line":1024},[915,3567,1004],{"class":1003},[915,3569,1029],{"class":1007},[915,3571,1011],{"class":1003},[915,3573,982],{"class":1014},[915,3575,1037],{"class":1036},[915,3577,1040],{"class":971},[915,3579,1011],{"class":1036},[915,3581,1021],{"class":925},[915,3583,3584,3586,3588,3590,3592,3594,3596],{"class":917,"line":1047},[915,3585,1004],{"class":1003},[915,3587,1313],{"class":1007},[915,3589,1011],{"class":1003},[915,3591,982],{"class":1014},[915,3593,1037],{"class":1036},[915,3595,1645],{"class":971},[915,3597,1215],{"class":1036},[915,3599,3600],{"class":917,"line":1062},[915,3601,1227],{"class":925},[856,3603,1654],{},[906,3605,3606],{"className":908,"code":1657,"language":910,"meta":911,"style":911},[863,3607,3608,3618,3626,3634,3638,3656,3674],{"__ignoreMap":911},[915,3609,3610,3612,3614,3616],{"class":917,"line":918},[915,3611,930],{"class":929},[915,3613,933],{"class":925},[915,3615,965],{"class":936},[915,3617,1670],{"class":936},[915,3619,3620,3622,3624],{"class":917,"line":975},[915,3621,979],{"class":978},[915,3623,982],{"class":929},[915,3625,985],{"class":971},[915,3627,3628,3630,3632],{"class":917,"line":988},[915,3629,1683],{"class":978},[915,3631,982],{"class":929},[915,3633,1688],{"class":971},[915,3635,3636],{"class":917,"line":994},[915,3637,997],{"class":925},[915,3639,3640,3642,3644,3646,3648,3650,3652,3654],{"class":917,"line":1000},[915,3641,1004],{"class":1003},[915,3643,1699],{"class":1007},[915,3645,1011],{"class":1003},[915,3647,982],{"class":1014},[915,3649,1037],{"class":1036},[915,3651,1708],{"class":971},[915,3653,1011],{"class":1036},[915,3655,1021],{"class":925},[915,3657,3658,3660,3662,3664,3666,3668,3670,3672],{"class":917,"line":1024},[915,3659,1004],{"class":1003},[915,3661,1719],{"class":1007},[915,3663,1011],{"class":1003},[915,3665,982],{"class":1014},[915,3667,1037],{"class":1036},[915,3669,1728],{"class":971},[915,3671,1011],{"class":1036},[915,3673,1021],{"class":925},[915,3675,3676],{"class":917,"line":1047},[915,3677,1227],{"class":925},[1738,3679,3680],{},[856,3681,1742],{},[1229,3683,1746],{"id":1745},[856,3685,1749],{},[1751,3687,3688,3698],{},[1754,3689,3690,1759,3692,1763,3694,1768,3696,1772],{},[863,3691,1758],{},[863,3693,1762],{},[1765,3695,1767],{},[1765,3697,1771],{},[1754,3699,3700,1778,3702,1782,3704,1786,3706,1793,3709,1798,3711],{},[863,3701,1777],{},[863,3703,1781],{},[863,3705,1785],{},[945,3707,1792],{"href":1789,"rel":3708},[1791],[1795,3710,1797],{},[1751,3712,3713,3717],{},[1754,3714,3715,1805],{},[863,3716,1781],{},[1754,3718,3719,1810],{},[863,3720,1785],{},[890,3722],{},[898,3724,1816],{"id":1815},[856,3726,1819,3727,982],{},[863,3728,882],{},[906,3730,3731],{"className":1824,"code":1825,"filename":1826,"language":1827,"meta":911,"style":911},[863,3732,3733,3751,3755,3769,3775,3781,3791,3797,3803,3807,3811,3815,3829,3851],{"__ignoreMap":911},[915,3734,3735,3737,3739,3741,3743,3745,3747,3749],{"class":917,"line":918},[915,3736,1834],{"class":921},[915,3738,1837],{"class":925},[915,3740,882],{"class":1840},[915,3742,1843],{"class":925},[915,3744,1846],{"class":921},[915,3746,1849],{"class":1036},[915,3748,1852],{"class":971},[915,3750,1855],{"class":1036},[915,3752,3753],{"class":917,"line":975},[915,3754,991],{"emptyLinePlaceholder":8},[915,3756,3757,3759,3761,3763,3765,3767],{"class":917,"line":988},[915,3758,1864],{"class":929},[915,3760,1868],{"class":1867},[915,3762,1871],{"class":1014},[915,3764,1874],{"class":921},[915,3766,1878],{"class":1877},[915,3768,1881],{"class":925},[915,3770,3771,3773],{"class":917,"line":994},[915,3772,1886],{"class":1840},[915,3774,1021],{"class":925},[915,3776,3777,3779],{"class":917,"line":1000},[915,3778,1893],{"class":1017},[915,3780,1021],{"class":925},[915,3782,3783,3785,3787,3789],{"class":917,"line":1024},[915,3784,1900],{"class":1036},[915,3786,1903],{"class":971},[915,3788,1906],{"class":1036},[915,3790,1021],{"class":925},[915,3792,3793,3795],{"class":917,"line":1047},[915,3794,1893],{"class":1017},[915,3796,1021],{"class":925},[915,3798,3799,3801],{"class":917,"line":1062},[915,3800,1893],{"class":1017},[915,3802,1021],{"class":925},[915,3804,3805],{"class":917,"line":1084},[915,3806,1925],{"class":1840},[915,3808,3809],{"class":917,"line":1101},[915,3810,1930],{"class":925},[915,3812,3813],{"class":917,"line":1118},[915,3814,991],{"emptyLinePlaceholder":8},[915,3816,3817,3819,3821,3823,3825,3827],{"class":917,"line":1139},[915,3818,1939],{"class":921},[915,3820,1942],{"class":925},[915,3822,1945],{"class":1840},[915,3824,1948],{"class":925},[915,3826,1008],{"class":1840},[915,3828,1953],{"class":925},[915,3830,3831,3833,3835,3837,3839,3841,3843,3845,3847,3849],{"class":917,"line":1160},[915,3832,1958],{"class":1840},[915,3834,1948],{"class":925},[915,3836,1963],{"class":1877},[915,3838,1966],{"class":925},[915,3840,1945],{"class":1840},[915,3842,1948],{"class":925},[915,3844,1052],{"class":1840},[915,3846,1948],{"class":925},[915,3848,1068],{"class":1840},[915,3850,1930],{"class":925},[915,3852,3853],{"class":917,"line":1181},[915,3854,1227],{"class":925},[856,3856,1985],{},[1229,3858,1989],{"id":1988},[1991,3860,3861,3871],{},[1994,3862,3863],{},[1997,3864,3865,3867,3869],{},[2000,3866,2002],{},[2000,3868,2005],{},[2000,3870,2008],{},[2010,3872,3873,3887,3905,3917,3931,3949],{},[1997,3874,3875,3879,3883],{},[2015,3876,3877],{},[863,3878,2019],{},[2015,3880,3881],{},[863,3882,2024],{},[2015,3884,2027,3885,2031],{},[1765,3886,2030],{},[1997,3888,3889,3893,3897],{},[2015,3890,3891],{},[863,3892,2038],{},[2015,3894,3895],{},[863,3896,2043],{},[2015,3898,2046,3899,2050,3901,2053,3903],{},[863,3900,2049],{},[863,3902,1186],{},[863,3904,1165],{},[1997,3906,3907,3911,3915],{},[2015,3908,3909],{},[863,3910,1203],{},[2015,3912,3913],{},[863,3914,2066],{},[2015,3916,2069],{},[1997,3918,3919,3923,3927],{},[2015,3920,3921],{},[863,3922,2076],{},[2015,3924,3925],{},[863,3926,2043],{},[2015,3928,2046,3929,2085],{},[863,3930,2049],{},[1997,3932,3933,3937,3941],{},[2015,3934,3935],{},[863,3936,2092],{},[2015,3938,3939],{},[863,3940,2043],{},[2015,3942,2046,3943,2101,3945,2105,3947],{},[863,3944,2049],{},[1765,3946,2104],{},[863,3948,2108],{},[1997,3950,3951,3955,3959],{},[2015,3952,3953],{},[863,3954,2115],{},[2015,3956,3957],{},[863,3958,2120],{},[2015,3960,2123],{},[1229,3962,2127],{"id":2126},[906,3964,3965],{"className":1824,"code":2130,"language":1827,"meta":911,"style":911},[863,3966,3967,3977,3987,3997,4043,4053,4063,4071],{"__ignoreMap":911},[915,3968,3969,3971,3973,3975],{"class":917,"line":918},[915,3970,2137],{"class":929},[915,3972,2140],{"class":929},[915,3974,1878],{"class":1877},[915,3976,1881],{"class":925},[915,3978,3979,3981,3983,3985],{"class":917,"line":975},[915,3980,1886],{"class":2149},[915,3982,982],{"class":1014},[915,3984,2155],{"class":2154},[915,3986,1021],{"class":925},[915,3988,3989,3991,3993,3995],{"class":917,"line":988},[915,3990,2162],{"class":2149},[915,3992,982],{"class":1014},[915,3994,2167],{"class":2154},[915,3996,1021],{"class":925},[915,3998,3999,4001,4003,4005,4007,4009,4011,4013,4015,4017,4019,4021,4023,4025,4027,4029,4031,4033,4035,4037,4039,4041],{"class":917,"line":994},[915,4000,2174],{"class":2149},[915,4002,982],{"class":1014},[915,4004,1849],{"class":1036},[915,4006,2181],{"class":971},[915,4008,1906],{"class":1036},[915,4010,2186],{"class":1014},[915,4012,1849],{"class":1036},[915,4014,1903],{"class":971},[915,4016,1906],{"class":1036},[915,4018,2186],{"class":1014},[915,4020,1849],{"class":1036},[915,4022,2199],{"class":971},[915,4024,1906],{"class":1036},[915,4026,2186],{"class":1014},[915,4028,1849],{"class":1036},[915,4030,2208],{"class":971},[915,4032,1906],{"class":1036},[915,4034,2186],{"class":1014},[915,4036,1849],{"class":1036},[915,4038,2217],{"class":971},[915,4040,1906],{"class":1036},[915,4042,1021],{"class":925},[915,4044,4045,4047,4049,4051],{"class":917,"line":1000},[915,4046,2226],{"class":2149},[915,4048,982],{"class":1014},[915,4050,2167],{"class":2154},[915,4052,1021],{"class":925},[915,4054,4055,4057,4059,4061],{"class":917,"line":1024},[915,4056,2237],{"class":2149},[915,4058,2240],{"class":1014},[915,4060,2167],{"class":2154},[915,4062,1021],{"class":925},[915,4064,4065,4067,4069],{"class":917,"line":1047},[915,4066,2249],{"class":2149},[915,4068,2240],{"class":1014},[915,4070,2254],{"class":2154},[915,4072,4073,4075,4077,4079,4081,4083,4085,4087],{"class":917,"line":1062},[915,4074,2259],{"class":925},[915,4076,982],{"class":1014},[915,4078,2264],{"class":2154},[915,4080,2267],{"class":925},[915,4082,2271],{"class":2270},[915,4084,2267],{"class":925},[915,4086,2276],{"class":2270},[915,4088,2279],{"class":925},[856,4090,2282],{},[906,4092,4093],{"className":1824,"code":2285,"language":1827,"meta":911,"style":911},[863,4094,4095,4099,4107,4121,4125,4137,4145,4153,4165,4177,4189,4197,4203,4207],{"__ignoreMap":911},[915,4096,4097],{"class":917,"line":918},[915,4098,997],{"class":925},[915,4100,4101,4103,4105],{"class":917,"line":975},[915,4102,2296],{"class":925},[915,4104,2049],{"class":1017},[915,4106,1021],{"class":925},[915,4108,4109,4111,4113,4115,4117,4119],{"class":917,"line":988},[915,4110,2305],{"class":925},[915,4112,2309],{"class":2308},[915,4114,2312],{"class":1877},[915,4116,2315],{"class":925},[915,4118,2318],{"class":1877},[915,4120,2321],{"class":925},[915,4122,4123],{"class":917,"line":994},[915,4124,2326],{"class":925},[915,4126,4127,4129,4131,4133,4135],{"class":917,"line":1000},[915,4128,2331],{"class":925},[915,4130,1906],{"class":1036},[915,4132,1077],{"class":971},[915,4134,1906],{"class":1036},[915,4136,1021],{"class":925},[915,4138,4139,4141,4143],{"class":917,"line":1024},[915,4140,2344],{"class":925},[915,4142,2347],{"class":936},[915,4144,1021],{"class":925},[915,4146,4147,4149,4151],{"class":917,"line":1047},[915,4148,2354],{"class":925},[915,4150,2357],{"class":936},[915,4152,1021],{"class":925},[915,4154,4155,4157,4159,4161,4163],{"class":917,"line":1062},[915,4156,2364],{"class":925},[915,4158,1011],{"class":1036},[915,4160,1132],{"class":971},[915,4162,1011],{"class":1036},[915,4164,1021],{"class":925},[915,4166,4167,4169,4171,4173,4175],{"class":917,"line":1084},[915,4168,2377],{"class":925},[915,4170,1011],{"class":1036},[915,4172,1153],{"class":971},[915,4174,1011],{"class":1036},[915,4176,1021],{"class":925},[915,4178,4179,4181,4183,4185,4187],{"class":917,"line":1101},[915,4180,2390],{"class":925},[915,4182,1011],{"class":1036},[915,4184,1174],{"class":971},[915,4186,1011],{"class":1036},[915,4188,1021],{"class":925},[915,4190,4191,4193,4195],{"class":917,"line":1118},[915,4192,2403],{"class":925},[915,4194,2357],{"class":936},[915,4196,1021],{"class":925},[915,4198,4199,4201],{"class":917,"line":1139},[915,4200,2412],{"class":1840},[915,4202,2416],{"class":2415},[915,4204,4205],{"class":917,"line":1160},[915,4206,1221],{"class":925},[915,4208,4209],{"class":917,"line":1181},[915,4210,1227],{"class":925},[856,4212,2427],{},[906,4214,4215],{"className":1824,"code":2430,"language":1827,"meta":911,"style":911},[863,4216,4217,4221,4229,4243,4253],{"__ignoreMap":911},[915,4218,4219],{"class":917,"line":918},[915,4220,997],{"class":925},[915,4222,4223,4225,4227],{"class":917,"line":975},[915,4224,2441],{"class":925},[915,4226,2108],{"class":1017},[915,4228,1021],{"class":925},[915,4230,4231,4233,4235,4237,4239,4241],{"class":917,"line":988},[915,4232,2450],{"class":925},[915,4234,2309],{"class":2308},[915,4236,2312],{"class":1877},[915,4238,2315],{"class":925},[915,4240,2318],{"class":1877},[915,4242,2321],{"class":925},[915,4244,4245,4247,4249,4251],{"class":917,"line":994},[915,4246,2465],{"class":925},[915,4248,1906],{"class":1036},[915,4250,1645],{"class":971},[915,4252,1855],{"class":1036},[915,4254,4255],{"class":917,"line":1000},[915,4256,1227],{"class":925},[856,4258,2478,4259,2481,4261,1948],{},[863,4260,1313],{},[863,4262,2484],{},[856,4264,2487,4265,2481,4267,2493,4269,2496,4271,1948],{},[863,4266,1313],{},[863,4268,2492],{},[863,4270,1313],{},[863,4272,2499],{},[856,4274,2502,4275,2506,4277,2510,4279,2514,4281,1948],{},[945,4276,2505],{"href":144},[863,4278,2509],{},[863,4280,2513],{},[863,4282,2517],{},[890,4284],{},[893,4286,2523],{"id":2522},[856,4288,2526,4289,2529],{},[863,4290,882],{},[898,4292,2533],{"id":2532},[856,4294,2536],{},[1751,4296,4297,4307,4309],{},[1754,4298,2541,4299,2544,4301,2548,4303,2552,4305,1948],{},[863,4300,2092],{},[1795,4302,2547],{},[1795,4304,2551],{},[1795,4306,2555],{},[1754,4308,2558],{},[1754,4310,2561,4311,2565],{},[1795,4312,2564],{},[898,4314,2569],{"id":2568},[856,4316,2572,4317,2576],{},[863,4318,2575],{},[898,4320,2580],{"id":2579},[856,4322,2583,4323,2587],{},[863,4324,2586],{},[1751,4326,4327,4333],{},[1754,4328,2592,4329,2596,4331,1948],{},[863,4330,2595],{},[863,4332,1203],{},[1754,4334,2601,4335,2604],{},[863,4336,1645],{},[872,4338,4339],{},[856,4340,2609,4341,2612,4343,2616],{},[863,4342,2038],{},[863,4344,2615],{},[898,4346,199],{"id":2619},[856,4348,2622,4349,2625,4351,2629],{},[863,4350,2076],{},[863,4352,2628],{},[1751,4354,4355,4357,4359],{},[1754,4356,2634],{},[1754,4358,2637],{},[1754,4360,2640,4361,2604],{},[863,4362,2643],{},[898,4364,2647],{"id":2646},[856,4366,2650,4367,2654],{},[863,4368,2653],{},[1751,4370,4371,4375],{},[1754,4372,2659,4373,2663],{},[863,4374,2662],{},[1754,4376,2666,4377,2670],{},[863,4378,2669],{},[898,4380,2674],{"id":2673},[856,4382,2677],{},[1751,4384,4385,4395,4397],{},[1754,4386,2609,4387,2684,4389,2688,4391,2692,4393,2696],{},[863,4388,2038],{},[863,4390,2687],{},[863,4392,2691],{},[1765,4394,2695],{},[1754,4396,2699],{},[1754,4398,2702],{},[890,4400],{},[893,4402,2708],{"id":2707},[898,4404,237],{"id":2711},[856,4406,2714,4407,2053,4409,2721,4411,1948],{},[863,4408,2717],{},[863,4410,2720],{},[863,4412,2724],{},[898,4414,4415],{"id":2727},[863,4416,2717],{},[1991,4418,4419,4431],{},[1994,4420,4421],{},[1997,4422,4423,4425,4427,4429],{},[2000,4424,2738],{},[2000,4426,2005],{},[2000,4428,2743],{},[2000,4430,2008],{},[2010,4432,4433],{},[1997,4434,4435,4439,4443,4447],{},[2015,4436,4437],{},[863,4438,2754],{},[2015,4440,4441],{},[863,4442,2043],{},[2015,4444,4445],{},[863,4446,2108],{},[2015,4448,2765],{},[898,4450,2769],{"id":2768},[1991,4452,4453,4461],{},[1994,4454,4455],{},[1997,4456,4457,4459],{},[2000,4458,2778],{},[2000,4460,2008],{},[2010,4462,4463,4473],{},[1997,4464,4465,4469],{},[2015,4466,4467],{},[863,4468,1758],{},[2015,4470,2791,4471,2795],{},[1765,4472,2794],{},[1997,4474,4475,4479],{},[2015,4476,4477],{},[863,4478,1777],{},[2015,4480,2804,4481],{},[1765,4482,2807],{},[890,4484],{},[898,4486,2813],{"id":2812},[1991,4488,4489,4497],{},[1994,4490,4491],{},[1997,4492,4493,4495],{},[2000,4494,2002],{},[2000,4496,2008],{},[2010,4498,4499,4507,4515,4523,4531,4539,4547,4555],{},[1997,4500,4501,4505],{},[2015,4502,4503],{},[863,4504,1068],{},[2015,4506,2834],{},[1997,4508,4509,4513],{},[2015,4510,4511],{},[863,4512,1089],{},[2015,4514,2843],{},[1997,4516,4517,4521],{},[2015,4518,4519],{},[863,4520,1106],{},[2015,4522,2852],{},[1997,4524,4525,4529],{},[2015,4526,4527],{},[863,4528,1123],{},[2015,4530,2861],{},[1997,4532,4533,4537],{},[2015,4534,4535],{},[863,4536,1144],{},[2015,4538,2870],{},[1997,4540,4541,4545],{},[2015,4542,4543],{},[863,4544,1165],{},[2015,4546,2879],{},[1997,4548,4549,4553],{},[2015,4550,4551],{},[863,4552,1186],{},[2015,4554,2888],{},[1997,4556,4557,4561],{},[2015,4558,4559],{},[863,4560,1203],{},[2015,4562,2897],{},[890,4564],{},[2901,4566,2903],{},{"title":911,"searchDepth":975,"depth":975,"links":4568},[4569,4573,4581],{"id":895,"depth":975,"text":896,"children":4570},[4571,4572],{"id":900,"depth":988,"text":901},{"id":1815,"depth":988,"text":1816},{"id":2522,"depth":975,"text":2523,"children":4574},[4575,4576,4577,4578,4579,4580],{"id":2532,"depth":988,"text":2533},{"id":2568,"depth":988,"text":2569},{"id":2579,"depth":988,"text":2580},{"id":2619,"depth":988,"text":199},{"id":2646,"depth":988,"text":2647},{"id":2673,"depth":988,"text":2674},{"id":2707,"depth":975,"text":2708,"children":4582},[4583,4584,4585,4586],{"id":2711,"depth":988,"text":237},{"id":2727,"depth":988,"text":2717},{"id":2768,"depth":988,"text":2769},{"id":2812,"depth":988,"text":2813},{},{"title":177,"description":2924},1780436285483]