...
Realize um POST para “
https://dpo.privacytools.com.br/consent/import/phone”Composição do Json para novos cadastrados de titulares de dados
Code Block { "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, "sendSMSMessage": "string", "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 |
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 |
sendSMSMessage | string | Mensagem que vai conter antes do link que o usuário vai receber por sms |
| Info |
|---|
O parametro parâmetro sendSMS precisa ser usado junto utilizado em conjunto com portalHash e email, pois o titular precisa ter deve possuir um portal da de privacidade para entrar logado e fazer gestão do consentimentoacessar logado e gerenciar o consentimento. Não é necessário fornecer algum tipo de consentimento no templateHash para consumir a API. Contudo, para utilizar o envio de SMS e habilitar o auto-login no link enviado por SMS, é obrigatório que a chave do provedor de SMS esteja registrada Integração com API de SMS e que os campos sendSMS, phone, portalHash e email estejam devidamente preenchidos no corpo da API. |