Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.
We are currently on Version 1 of our API. All API requests can be made to:
https://api.everprotec.com/v1
Every request you make to our API will need to be authenticated. To maximize security, your credentials are configured on a per site basis. Follow the authentication guide here to learn how to configure authentication for your integration.
We enforce strict HTTPS usage. Non HTTPS requests will be rejected.
To generate your first verification session invitation link, you will need to have a site configured in the dashboard. The siteId, which is required for invite requests, can be found in the url to the settings page for your site.View the Create Invitation endpoint documentation to test your first API request and learn how to integrate with our API in your project. To dive in deeper, we recommend getting started with our workflow and webhook guides.
All of our APIs are documented with OpenAPI spec. This link takes you to our openapi.json file for ingestion in your project.
{"docsConfig":{"theme":"mint","$schema":"https://docs.everprotec.com/docs.json","name":"Everprotec","colors":{"primary":"#16A34A","light":"#07C983","dark":"#15803D"},"logo":{"light":"https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/logo/light.png?fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=45b8f4404c8bf830a31760eba2340ef7","dark":"https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/logo/dark.png?fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=1458dc5d70b8612520a401bde3439823"},"favicon":"/favicon.ico","navbar":{"links":[{"label":"Signup","href":"https://everprotec.com/"},{"label":"Support","href":"mailto:support@everprotec.com"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.everprotec.com"}},"footer":{"socials":{"bluesky":"https://bsky.app/profile/everprotec.com"}},"navigation":{"global":{"anchors":[{"anchor":"Everprotec Home","icon":"home","href":"https://everprotec.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"everprotec","hasAudioNarration":false,"actualSubdomain":"everprotec","customDomains":["docs.everprotec.com"],"gitSource":{"type":"github","owner":"everprotec","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21ac81be88a3b4fd9f72b7","collectionId":"155b4aa8-a2a7-4427-91fa-50c5821ec238","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21ac81be88a3b4fd9f72b7:success","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API reference","count":7},{"language":"default","tag":"Guides","count":7},{"language":"default","tag":"API documentation","count":4},{"language":"default","tag":"Age Gateway Invites","count":2},{"language":"default","tag":"Getting started","count":2},{"language":"default","tag":"Webhook Messages","count":1},{"language":"default","tag":"Reference","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/introduction","slug":"/api-reference/introduction","pageMetadata":{"title":"API Introduction","description":"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.","href":"/api-reference/introduction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,em:`em`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{Card,CodeBlock,Columns,Heading,Note,OptimizedImage}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Columns)_missingMdxReference(`Columns`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`getting-started`,children:`Getting Started`}),`\n`,_jsxs(_components.p,{children:[`We are currently on `,_jsx(_components.strong,{children:`Version 1`}),` of our API. All API requests can be made to:`]}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`https://api.everprotec.com/v1`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`Every request you make to our API will need to be authenticated. To maximize security, your credentials are configured on a per site basis. Follow the authentication guide `,_jsx(_components.a,{href:`/api-reference/authentication`,children:`here`}),` to learn how to configure authentication for your integration.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`We enforce strict HTTPS usage. Non HTTPS requests will be rejected.`})}),`\n`,_jsxs(_components.p,{children:[`To generate your first verification session invitation link, you will need to have a site configured in the `,_jsx(_components.a,{href:`https://dashboard.everprotec.com/web`,children:`dashboard`}),`. The `,_jsx(_components.em,{children:`siteId`}),`, which is required for invite requests, can be found in the url to the settings page for your site.`]}),`\n`,_jsx(OptimizedImage,{src:`https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/images/site-id.png?fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=b0b6d6c40c1826acfe4b3167acc953f8`,alt:`dashboard.everprotec.com/web/settings/your_site_ID_here`,\"data-og-width\":`687`,width:`687`,\"data-og-height\":`270`,height:`270`,\"data-path\":`images/site-id.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/images/site-id.png?w=280\u0026fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=1e27f6020f1791d6d95ecb40c858a4a3 280w, https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/images/site-id.png?w=560\u0026fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=35b5be07d5eaced5b35b71e3b3a8fe27 560w, https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/images/site-id.png?w=840\u0026fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=089ccbcc39d79fe3ee6def34a726dece 840w, https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/images/site-id.png?w=1100\u0026fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=82e2833c062392ef6aa4ca580f84a8b5 1100w, https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/images/site-id.png?w=1650\u0026fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=b3944503c6f4cd05cc26b7dc1123d9ac 1650w, https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/images/site-id.png?w=2500\u0026fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=73a625251eccf020aaa1f7935a426fcf 2500w`}),`\n`,_jsxs(_components.p,{children:[`View the `,_jsx(_components.a,{href:`/api-reference/endpoint/create-invite`,children:`Create Invitation`}),` endpoint documentation to test your first API request and learn how to integrate with our API in your project. To dive in deeper, we recommend getting started with our `,_jsx(_components.a,{href:`/api-reference/ag-workflow`,children:`workflow`}),` and `,_jsx(_components.a,{href:`/api-reference/webhooks`,children:`webhook`}),` guides.`]}),`\n`,_jsx(Heading,{level:`2`,id:`guides`,children:`Guides`}),`\n`,_jsxs(Columns,{cols:2,children:[_jsx(Card,{title:`Age Gateway Workflow`,icon:`map`,href:`/api-reference/ag-workflow`,children:_jsx(_components.p,{children:`Learn how to establish an integration with our Age Verification Gateway.`})}),_jsx(Card,{title:`Handling Webhook Messages`,icon:`pen-to-square`,href:`/api-reference/webhooks`,children:_jsx(_components.p,{children:`Learn how to securely receive webhook messages from Everprotec.`})})]}),`\n`,_jsx(Heading,{level:`2`,id:`openapi`,children:`OpenAPI`}),`\n`,_jsx(Card,{title:`Everprotec OpenAPI Specification`,icon:`terminal`,href:`https://github.com/Everprotec/docs/blob/main/api-reference/openapi.json`,children:_jsx(_components.p,{children:`All of our APIs are documented with OpenAPI spec. This link takes you to our openapi.json file for ingestion in your project.`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"API Introduction","description":"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.","href":"/api-reference/introduction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Getting Started","slug":"getting-started","depth":2,"children":[]},{"title":"Guides","slug":"guides","depth":2,"children":[]},{"title":"OpenAPI","slug":"openapi","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"everprotec","siteName":"Everprotec","title":"API Introduction - Everprotec","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-11-27T15:06:36.572Z","originalFileLocation":"api-reference/introduction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Everprotec\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API Introduction - Everprotec\">\u003cmeta data-mint-head property=\"og:description\" content=\"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Everprotec\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.everprotec.com/api-reference/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://everprotec.mintlify.app/_mintlify/api/og/v2?division=API+documentation\u0026amp;title=API+Introduction\u0026amp;description=Our+API+enables+you+to+automatically+generate+links+for+our+Age+Verification+Gateway+to+verify+users+from+your+website.+In+this+documentation%2C+you+will+find+det\u0026amp;theme=72dc8ed06af2d609b13a3957\u0026amp;signature=5f476517477605ebcfae240efc7174b10535777946f16429dd62243c01d4d722\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API Introduction - Everprotec\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://everprotec.mintlify.app/_mintlify/api/og/v2?division=API+documentation\u0026amp;title=API+Introduction\u0026amp;description=Our+API+enables+you+to+automatically+generate+links+for+our+Age+Verification+Gateway+to+verify+users+from+your+website.+In+this+documentation%2C+you+will+find+det\u0026amp;theme=72dc8ed06af2d609b13a3957\u0026amp;signature=5f476517477605ebcfae240efc7174b10535777946f16429dd62243c01d4d722\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/everprotec/jXK_tsqzd5fKnEdS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Everprotec\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#16A34A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.everprotec.com/api-reference/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/introduction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.everprotec.com/#organization\",\"name\":\"Everprotec\",\"url\":\"https://docs.everprotec.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/everprotec/Ocg9zBVgmMeIF8o1/logo/light.png?fit=max\u0026auto=format\u0026n=Ocg9zBVgmMeIF8o1\u0026q=85\u0026s=45b8f4404c8bf830a31760eba2340ef7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.everprotec.com#website\",\"name\":\"Everprotec\",\"url\":\"https://docs.everprotec.com\",\"publisher\":{\"@id\":\"https://docs.everprotec.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.everprotec.com/api-reference/introduction#webpage\",\"url\":\"https://docs.everprotec.com/api-reference/introduction\",\"name\":\"API Introduction\",\"description\":\"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.\",\"dateModified\":\"2025-11-27T15:06:36.572Z\",\"isPartOf\":{\"@id\":\"https://docs.everprotec.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.everprotec.com/api-reference/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.everprotec.com/api-reference/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Everprotec\",\"item\":\"https://docs.everprotec.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Introduction\",\"item\":\"https://docs.everprotec.com/api-reference/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.everprotec.com/api-reference/introduction#article\",\"headline\":\"API Introduction\",\"name\":\"API Introduction\",\"description\":\"Our API enables you to automatically generate links for our Age Verification Gateway to verify users from your website. In this documentation, you will find details on how to authenticate, create a verification session invitation link, and check the status of a verification session.\",\"url\":\"https://docs.everprotec.com/api-reference/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.everprotec.com/api-reference/introduction#webpage\"},\"dateModified\":\"2025-11-27T15:06:36.572Z\",\"publisher\":{\"@id\":\"https://docs.everprotec.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.everprotec.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Everprotec\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Everprotec","nav":{"global":{"anchors":[{"anchor":"Everprotec Home","icon":"home","href":"https://everprotec.com/"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"API documentation","pages":[{"title":"API Introduction","href":"/api-reference/introduction"},{"title":"Authentication","description":"Here is how to authenticate your API requests","href":"/api-reference/authentication"},{"title":"Webhooks","href":"/api-reference/webhooks"},{"title":"Age Gateway Workflow","href":"/api-reference/ag-workflow"}]},{"group":"Age Gateway Invites","pages":[{"title":"Create Invite","openapi":"POST /website/{siteId}/invite","href":"/api-reference/endpoint/create-invite"},{"title":"Get Invite Status","openapi":"GET /website/{siteId}/invite/{inviteId}","href":"/api-reference/endpoint/get-invite"}]},{"group":"Webhook Messages","pages":[{"title":"Webhook Verification Success","openapi":"WEBHOOK verificationSuccess","href":"/api-reference/webhook/verification-success"}]}]}]},"basePath":"","title":"API Introduction - Everprotec","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["a74be98ba7"],"chunks":["zoom-image-lightbox-DL4wrF0w.js","lightbox-handle-r17bVUz3.js"]}
