CINXE.COM
<!doctype html> <html lang="en" dir="ltr" class="plugin-pages plugin-id-default"> <head> <meta charset="UTF-8"> <meta name="generator" content="Docusaurus v2.4.1"> <title data-rh="true">illow's API Documentation - Plug & Play tools to make websites privacy-compliant</title><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docusaurus_tag" content="default"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:docusaurus_tag" content="default"><meta data-rh="true" charset="utf-8"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="description" content="illow provides your company with plug & play tools to make your website privacy-compliant"><meta data-rh="true" name="keywords" content="DSR Automation, Universal Consent, Cookie Banner, GDPR, LGPD, CCPA, Aviso de Cookies, Adequacao a LGPD, LGPD politica de privacidade, LGPD Cookies, LGPD site, LGPD politica de cookies, Consentimento LGPD"><meta data-rh="true" property="og:url" content="https://docs.illow.io/"><meta data-rh="true" property="og:site_name" content="illow's API Documentation - Plug & Play tools to make websites privacy-compliant"><meta data-rh="true" property="og:image" content="https://docs.illow.io/img/illow_og.png"><meta data-rh="true" property="og:image:secure_url" content="https://docs.illow.io/img/illow_og.png"><meta data-rh="true" property="og:title" content="illow's API Documentation - Plug & Play tools to make websites privacy-compliant"><meta data-rh="true" property="og:description" content="illow provides your company with plug & play tools to make your website privacy-compliant"><meta data-rh="true" property="og:type" content="website"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" name="twitter:description" content="illow provides your company with plug & play tools to make your website privacy-compliant"><meta data-rh="true" name="twitter:title" content="illow Privacy"><meta data-rh="true" name="twitter:site" content="@illow_privacy"><meta data-rh="true" name="twitter:image:src" content="https://docs.illow.io/img/illow_og.png"><meta data-rh="true" name="twitter:creator" content="@illow_privacy"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="alternate" href="https://docs.illow.io/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.illow.io/" hreflang="x-default"><link data-rh="true" rel="icon" href="/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.illow.io/"><link data-rh="true" rel="shortcut icon" href="https://docs.illow.io/img/illow_og.png"><script data-rh="true">function maybeInsertBanner(){window.__DOCUSAURUS_INSERT_BASEURL_BANNER&&insertBanner()}function insertBanner(){var n=document.getElementById("__docusaurus-base-url-issue-banner-container");if(n){n.innerHTML='\n<div id="__docusaurus-base-url-issue-banner" style="border: thick solid red; background-color: rgb(255, 230, 179); margin: 20px; padding: 20px; font-size: 20px;">\n <p style="font-weight: bold; font-size: 30px;">Your Docusaurus site did not load properly.</p>\n <p>A very common reason is a wrong site <a href="https://docusaurus.io/docs/docusaurus.config.js/#baseUrl" style="font-weight: bold;">baseUrl configuration</a>.</p>\n <p>Current configured baseUrl = <span style="font-weight: bold; color: red;">/</span> (default value)</p>\n <p>We suggest trying baseUrl = <span id="__docusaurus-base-url-issue-banner-suggestion-container" style="font-weight: bold; color: green;"></span></p>\n</div>\n';var e=document.getElementById("__docusaurus-base-url-issue-banner-suggestion-container"),s=window.location.pathname,r="/"===s.substr(-1)?s:s+"/";e.innerHTML=r}}window.__DOCUSAURUS_INSERT_BASEURL_BANNER=!0,document.addEventListener("DOMContentLoaded",maybeInsertBanner)</script><script data-rh="true" src="https://platform.illow.io/banner.js?siteId=4adcc57c-6434-4a22-bcb6-f9613adcf17b"></script><link rel="stylesheet" href="/assets/css/styles.0ab00c65.css"> <link rel="preload" href="/assets/js/runtime~main.59f5848c.js" as="script"> <link rel="preload" href="/assets/js/main.d0910e75.js" as="script"> </head> <body class="navigation-with-keyboard"> <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus"> <div id="__docusaurus-base-url-issue-banner-container"></div><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="illow logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo-dark.svg" alt="illow logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">illow Docs</b></a><a class="navbar__item navbar__link" href="/docs/introduction">Getting Started</a><a class="navbar__item navbar__link" href="/docs/cookie-consent/use-cases/new-unauthenticated-visitor">Use Cases</a><a href="https://api.platform.illow.io/open-api/v1" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">API Reference</a><a class="navbar__item navbar__link" href="/docs/cookie-consent/website-sdk/getting-started">Website SDK</a><a class="navbar__item navbar__link" href="/docs/universal-consent/introduction">Universal Consent</a></div><div class="navbar__items navbar__items--right"><a href="https://illow.io" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">illow.io<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="md:pb-16"><header class="mt-4 lg:-mt-16 px-6 lg:px-32 flex justify-center lg:justify-between items-center flex-wrap lg:flex-nowrap"><div class="pr-0 lg:pr-24"><h1 class="text-4xl">Documentation</h1><p class="text-xl">Learn how to make your websites privacy compliant in minutes with illow.</p></div><img class="w-full max-w-[33rem] -mt-8 lg:mt-0" alt="illow-banner" src="img/illow_google_consent_mode_v2.webp"></header><section class="px-6 md:px-32 grid md:grid-cols-2 lg:grid-cols-4 gap-4"><div><h3>Getting Started</h3><ul class="list-none pl-0"><li><a href="docs/introduction" target="_self">Introduction</a></li><li><a href="docs/cookie-consent/cookie-banner/creating-a-cookie-banner" target="_self">Creating a Cookie Banner</a></li><li><a href="docs/cookie-consent/cookies-categorization/introduction" target="_self">Cookies Categorization</a></li><li><a href="docs/cookie-consent/banner-by-region/introduction" target="_self">Dynamic Banner</a></li><li><a href="docs/universal-consent/introduction" target="_self">Universal Consent</a></li></ul></div><div><h3>Use Cases</h3><ul class="list-none pl-0"><li><a href="docs/cookie-consent/use-cases/new-unauthenticated-visitor" target="_self">New unauthenticated visitor</a></li><li><a href="docs/cookie-consent/use-cases/returning-unauthenticated-visitor" target="_self">Returning unauthenticated visitor</a></li><li><a href="docs/cookie-consent/use-cases/authenticated-visitor" target="_self">Authenticated visitor</a></li><li><a href="docs/cookie-consent/use-cases/global-privacy-control" target="_self">Global Privacy Control (GPC)</a></li></ul></div><div><h3>Reference</h3><ul class="list-none pl-0"><li><a href="https://api.platform.illow.io/open-api/v1" target="_blank">API</a></li><li><a href="docs/cookie-consent/website-sdk/getting-started" target="_self">Website SDK</a></li></ul></div><div><h3>No-code</h3><ul class="list-none pl-0"><li><a href="https://platform.illow.io/#/sign-up?utm_content=docs.illow.io" target="_blank">Design your cookie banner</a></li><li><a href="https://platform.illow.io/#/sign-up?utm_content=docs.illow.io" target="_blank">Cookie scanning</a></li><li><a href="https://platform.illow.io/#/sign-up?utm_content=docs.illow.io" target="_blank">Cookie policy generator</a></li><li><a href="https://platform.illow.io/#/sign-up?utm_content=docs.illow.io" target="_blank">Privacy policy generator</a></li><li><a href="https://platform.illow.io/#/sign-up?utm_content=docs.illow.io" target="_blank">Create your privacy portal</a></li></ul></div></section></main></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Comply with</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://illow.io/blog/gdpr" target="_blank" rel="noopener noreferrer" class="footer__link-item">GDPR</a></li><li class="footer__item"><a href="https://illow.io/blog/quebec-canada-how-to-make-your-site-compliant-with-quebec-25-law" target="_blank" rel="noopener noreferrer" class="footer__link-item">Law 25</a></li><li class="footer__item"><a href="https://illow.io/blog/california-ccpa-how-to-make-your-site-ccpa-compliant" target="_blank" rel="noopener noreferrer" class="footer__link-item">CCPA</a></li><li class="footer__item"><a href="https://illow.io/blog/brazil-lgpd-how-to-make-your-site-lgpd-compliant" target="_blank" rel="noopener noreferrer" class="footer__link-item">LGPD</a></li><li class="footer__item"><a href="https://illow.io/blog/category/privacy-regulations" target="_blank" rel="noopener noreferrer" class="footer__link-item">All regulations</a></li></ul></div><div class="col footer__col"><div class="footer__title">Resources</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://illow.io/blog" target="_blank" rel="noopener noreferrer" class="footer__link-item">Blog</a></li><li class="footer__item"><a href="https://illow.freshdesk.com/support/solutions" target="_blank" rel="noopener noreferrer" class="footer__link-item">Knowledgebase</a></li><li class="footer__item"><a href="https://illow.io/pricing" target="_blank" rel="noopener noreferrer" class="footer__link-item">Compare Plans</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.linkedin.com/company/illow/" target="_blank" rel="noopener noreferrer" class="footer__link-item">LinkedIn</a></li><li class="footer__item"><a href="https://twitter.com/illow_privacy" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter</a></li><li class="footer__item"><a href="https://instagram.com/illow.io" target="_blank" rel="noopener noreferrer" class="footer__link-item">Instagram</a></li><li class="footer__item"><a href="https://www.facebook.com/illow.io" target="_blank" rel="noopener noreferrer" class="footer__link-item">Facebook</a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://illow.io" target="_blank" rel="noopener noreferrer" class="footer__link-item">illow.io</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright 漏 2024 illow, Inc. Built with 鉂わ笍 for all companies and devs creating a more transparent ecosystem.</div></div></div></footer></div> <script src="/assets/js/runtime~main.59f5848c.js"></script> <script src="/assets/js/main.d0910e75.js"></script> </body> </html>