API consent/import/phone

Importa um titular e seu status de consentimento. Usa apenas telefone. E-mail não é obrigatório.

Metodo POST https://dpo.privacytools.com.br/external_api_v2/swagger-ui.html#/external-consent-controller/importByPhoneNumberUsingPOST

Esse passo a passo serve para realizar a integração de um formulário de consentimentos aplicado no seu site com a nossa plataforma.

Primeiramente você deve criar um usuário de API na sua plataforma, segue a documentação:

Usuários para API

Após criar um usuário de API, você deve criar o seu formulário que será disponibilizado na sua plataforma.

Você deve criar a Finalidade dentro da plataforma para gerar o hash do registro que será vinculado ao consentimento:

Gerenciando Finalidades

Após essas configurações você pode utilizar a API de integração abaixo:

Realize um POST para “https://dpo.privacytools.com.br/consent/import/phone”

Composição do Json para novos cadastrados de titulares de dados

{
  "consentDate": "string",
  "consentValue": true,
  "document": "string",
  "email": "string",
  "formOrigin": "string",
  "groupName": "string",
  "hashUser": "string",
  "metadata": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "phone": "string",
  "portalHash": "string",
  "sendEmailPortal": true,
  "sendEmailPortalResetPassword": true,
  "sendSMS": true,
  "templateHash": "string",
  "updateUserData": true,
  "userAgent": "string",
  "userIp": "string",
  "websiteOrigin": "string"
}

Variável	Resposta	Significado
consentDate	string	Data do consentimento. Formatos possíveis: "yyyy-MM-dd’T’HH:mm:ss.SSSZ", "MM/dd/yyyy", "dd/MM/yyyy", "MM/dd/yyyy hh:mm:ss", "dd/MM/yyyy HH:mm", "dd/MM/yyyy HH:mm:ss", “MM/dd/yyyy hh:mm:ss a”
consentValue	boolean	Resposta do consentimento “true” / “false”
document	string	CPF do titular
email	string	Email do titular
formOrigin	string	Formulário de origem
groupName	string	Grupo de titulares
hashUser	string	Hash identificador do titular
metadata	string	Lista de metadados
name	string	Nome do titular
phone	string	Telefone do titular
portalHash	string	Hash do portal que será usado para mandar email ao usuário
sendEmailPortal	string	Se o sistema deve enviar email para acesso ao portal da privacidade
sendEmailPortalResetPassword	string	Se o sistema deve enviar email de criação ou troca de senha para acesso ao portal da privacidade
sendSMS	string	habilita o envio de SMS para titular (Cadastro do titular deve ter o phone)
templateHash	string	Hash do consentimento
updateUserData	boolean	Se o sistema deve atualizar o titular “true” / “false”
userAgent	string	User-Agent da requisição do Titular para armazenar origin do da requisição original (browser titular)
userIp	string	Ip da requisição do titular para armazenar ip da origin da requisição original
websiteOrigin	string	Website de origem

O parametro sendSMS precisa ser usado junto com portalHash pois o titular precisa ter um portal da privacidade para entrar logado e fazer gestão do consentimento.

API consent/import/phone

Variável

Significado