Documentation

Welcome to GetComplied! Get familiar with the GetComplied products and explore their features:


What is GetComplied?

GetComplied is the most powerful and flexible software for you to comply with the GDPR EU rules. Whenever you create a website, an app, a portal, a landing page, or a software, the GetComplied mission is to provide the most efficient solution to help you comply with the law.

Why use GetComplied?

Until May 25, all websites, apps, and platforms must comply with the GDPR EU Law.


Snippet Example

The following code is a test example of the snippet. So you can see how it looks like in your website.


Install - First Steps

1 - Create an account

Create your GetComplied account at www.getcomplied.com

2 - Policies and Cookies

Create the policies and cookies for your platform. You will need them when we create a project.

3 - Create a project

Create a project, get your snippet code and put it on your website.

4 - Add Snippet

After creating the project you only need to add the snippet to your site.

Install the code before </body>


Configure

For each project you can configured and customize the settings. When editing a project you can customize:

  • Project Information
    Choose a unique name for your project. A simple name to identify it.
  • Business Information
    Add conrrespondant legal info about this project.
  • DPO Information
    This section is mandatory per the GDPR. Add the DPO information so that the users can reach it.
  • Languages
    Choose the default and the active languages for the project.
  • Themes
    You can customize the Logo (add the url of the image of your logo) and the Header background color (the color is in rgb format, ex: "#cccccc" ).
  • What policies to use
    After creating the policies you can select which ones to use in the project.
  • What cookies to use
    After creating the cookies you can select which ones to use in the cookies.
  • What platforms to use
    After creating the platforms you can select which ones to use in the project.

Web SDK

Language

Default language can be set on your project settings. It can be overriten by using
getComplied.lang = 'en' when the popup is closed. Next time that is openned, it will change to the chosen language.

NOTE: It must be put after your snippet code.

Inside Container

GeComplied can be inside of a html tag on your website instead of being a popup.
When this is applied, it will be always visible.
It will no longer listen to certain commands or execute some callbacks.

Affected commands: show
Affected callbacks: onopen, onclose

HTML
<gpdr-prompt-container></gpdr-prompt-container>
JAVASCRIPT
getComplied.container = document.getElementById('yourElementId')

NOTE: JAVASCRIPT code must be put after your snippet code.

Z-Index

Default z-index value is 10000. It can be set by using getComplied.zIndex = 999.

NOTE: It must be put after your snippet code.

Animation

Default value is true. It can be set by using getComplied.animate = true.

NOTE: It must be put after your snippet code.

Events

Commands are used to comunicate with the popup via javascript.

Command Description
getComplied.command('show')
Open Modal
Privacy Settings
getComplied.command('hide')
Close Modal
getComplied.command('send', 'view', 123)
Opent a specifiq resource by ID
Terms & Conditions
getComplied.command('send', 'index', 4)
Opent a specifiq resource by Index
Open in the 4th Policy

NOTE: It must be put after your snippet code.


Query String

You can communicate with the modal via query string. This is ideal to validate legacy data. Example you can use a query string to pass the email that way Get Compiled knows exactly what user is using the platform. Ex: You can send a newsletter to your customers to let them know that you changed your terms and conditions, send the to the homepage with the query string passing the email.

Query String Scope Description Example
gc-email
USER
Pass the users email to GetComplied
?gc-email=user@email.com
View Example
gc-name
USER
Pass the users name to GetComplied
?gc-name=firstlastname
View Example
gc-open
Modal
Force the modal to open
?gc-open=1
View Example
gc-lang
Modal
Force a language to open
?gc-lang=pt-PT
View Example
gc-index
Modal
Choose what resource to be open
?gc-index=1
View Example
gc-view
Modal
Open a specifiq resource by ID
?gc-view=4
View Example

NOTE: It must be put after your snippet code.


Debug Console

You can open the debug console with the following technique:

Query String Scope Description Example
gc-debug
MODAL
Open Console
?gc-debug=1
View Example

NOTE: It must be put after your snippet code.


Want to integrate with a CMS, ERP or CRM?

A custom GetComplied integration requires you to either be or hire a developer.

Manage all your projects gdpr privacy policies and gdpr cookies in one platform.

Salesforce gdpr compliance Extension
Microsoft gdpr compliance Plugin
Zoho gdpr compliance Extension
Zoho gdpr compliance Extension
Zoho gdpr compliance Extension

Manage all your customers
privacy in one platform.


We're here to help!

We're always happy to help with code or any questions you have.

Join our mailing list to be notified of API changes and stay up to date.



Questions?

We're always happy to help with code or other questions you might have! Contact support or connect with our sales team.