Create consent
curl --request POST \
--url https://www.consentfly.com.br/api/v1/consents \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"site_id": "6b8b4567-327a-4d10-92a5-9e8c4f5a7d12",
"subject_id": "user_sha256_a1b2c3d4e5f6",
"consent_id": "analytics-2026-05",
"accepted": true,
"preferences": {
"analytics": true,
"marketing": false,
"functional": true
},
"policy_version": 3,
"ip_address": "200.150.100.50",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15"
}
'import requests
url = "https://www.consentfly.com.br/api/v1/consents"
payload = {
"site_id": "6b8b4567-327a-4d10-92a5-9e8c4f5a7d12",
"subject_id": "user_sha256_a1b2c3d4e5f6",
"consent_id": "analytics-2026-05",
"accepted": True,
"preferences": {
"analytics": True,
"marketing": False,
"functional": True
},
"policy_version": 3,
"ip_address": "200.150.100.50",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_id: '6b8b4567-327a-4d10-92a5-9e8c4f5a7d12',
subject_id: 'user_sha256_a1b2c3d4e5f6',
consent_id: 'analytics-2026-05',
accepted: true,
preferences: {analytics: true, marketing: false, functional: true},
policy_version: 3,
ip_address: '200.150.100.50',
user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15'
})
};
fetch('https://www.consentfly.com.br/api/v1/consents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.consentfly.com.br/api/v1/consents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site_id' => '6b8b4567-327a-4d10-92a5-9e8c4f5a7d12',
'subject_id' => 'user_sha256_a1b2c3d4e5f6',
'consent_id' => 'analytics-2026-05',
'accepted' => true,
'preferences' => [
'analytics' => true,
'marketing' => false,
'functional' => true
],
'policy_version' => 3,
'ip_address' => '200.150.100.50',
'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.consentfly.com.br/api/v1/consents"
payload := strings.NewReader("{\n \"site_id\": \"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12\",\n \"subject_id\": \"user_sha256_a1b2c3d4e5f6\",\n \"consent_id\": \"analytics-2026-05\",\n \"accepted\": true,\n \"preferences\": {\n \"analytics\": true,\n \"marketing\": false,\n \"functional\": true\n },\n \"policy_version\": 3,\n \"ip_address\": \"200.150.100.50\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.consentfly.com.br/api/v1/consents")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"site_id\": \"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12\",\n \"subject_id\": \"user_sha256_a1b2c3d4e5f6\",\n \"consent_id\": \"analytics-2026-05\",\n \"accepted\": true,\n \"preferences\": {\n \"analytics\": true,\n \"marketing\": false,\n \"functional\": true\n },\n \"policy_version\": 3,\n \"ip_address\": \"200.150.100.50\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.consentfly.com.br/api/v1/consents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_id\": \"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12\",\n \"subject_id\": \"user_sha256_a1b2c3d4e5f6\",\n \"consent_id\": \"analytics-2026-05\",\n \"accepted\": true,\n \"preferences\": {\n \"analytics\": true,\n \"marketing\": false,\n \"functional\": true\n },\n \"policy_version\": 3,\n \"ip_address\": \"200.150.100.50\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15\"\n}"
response = http.request(request)
puts response.read_body{
"id": "01HK8VV4P9R3T8M2A2YZJ7HQ5Q",
"site_id": "6b8b4567-327a-4d10-92a5-9e8c4f5a7d12",
"subject_id": "user_sha256_a1b2c3d4e5f6",
"consent_id": "analytics-2026-05",
"accepted": true,
"preferences": {
"analytics": true,
"marketing": false,
"functional": true
},
"policy_version": 3,
"country": "BR",
"region": "SP",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15",
"created_at": "2026-05-24T10:30:00Z",
"updated_at": "2026-05-24T10:30:00Z",
"deleted_at": null
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}Consents
Create consent
Records a consent for a site you own. API key requests consume one unit of the monthly API quota.
POST
/
consents
Create consent
curl --request POST \
--url https://www.consentfly.com.br/api/v1/consents \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"site_id": "6b8b4567-327a-4d10-92a5-9e8c4f5a7d12",
"subject_id": "user_sha256_a1b2c3d4e5f6",
"consent_id": "analytics-2026-05",
"accepted": true,
"preferences": {
"analytics": true,
"marketing": false,
"functional": true
},
"policy_version": 3,
"ip_address": "200.150.100.50",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15"
}
'import requests
url = "https://www.consentfly.com.br/api/v1/consents"
payload = {
"site_id": "6b8b4567-327a-4d10-92a5-9e8c4f5a7d12",
"subject_id": "user_sha256_a1b2c3d4e5f6",
"consent_id": "analytics-2026-05",
"accepted": True,
"preferences": {
"analytics": True,
"marketing": False,
"functional": True
},
"policy_version": 3,
"ip_address": "200.150.100.50",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
site_id: '6b8b4567-327a-4d10-92a5-9e8c4f5a7d12',
subject_id: 'user_sha256_a1b2c3d4e5f6',
consent_id: 'analytics-2026-05',
accepted: true,
preferences: {analytics: true, marketing: false, functional: true},
policy_version: 3,
ip_address: '200.150.100.50',
user_agent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15'
})
};
fetch('https://www.consentfly.com.br/api/v1/consents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.consentfly.com.br/api/v1/consents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'site_id' => '6b8b4567-327a-4d10-92a5-9e8c4f5a7d12',
'subject_id' => 'user_sha256_a1b2c3d4e5f6',
'consent_id' => 'analytics-2026-05',
'accepted' => true,
'preferences' => [
'analytics' => true,
'marketing' => false,
'functional' => true
],
'policy_version' => 3,
'ip_address' => '200.150.100.50',
'user_agent' => 'Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.consentfly.com.br/api/v1/consents"
payload := strings.NewReader("{\n \"site_id\": \"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12\",\n \"subject_id\": \"user_sha256_a1b2c3d4e5f6\",\n \"consent_id\": \"analytics-2026-05\",\n \"accepted\": true,\n \"preferences\": {\n \"analytics\": true,\n \"marketing\": false,\n \"functional\": true\n },\n \"policy_version\": 3,\n \"ip_address\": \"200.150.100.50\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.consentfly.com.br/api/v1/consents")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"site_id\": \"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12\",\n \"subject_id\": \"user_sha256_a1b2c3d4e5f6\",\n \"consent_id\": \"analytics-2026-05\",\n \"accepted\": true,\n \"preferences\": {\n \"analytics\": true,\n \"marketing\": false,\n \"functional\": true\n },\n \"policy_version\": 3,\n \"ip_address\": \"200.150.100.50\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.consentfly.com.br/api/v1/consents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"site_id\": \"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12\",\n \"subject_id\": \"user_sha256_a1b2c3d4e5f6\",\n \"consent_id\": \"analytics-2026-05\",\n \"accepted\": true,\n \"preferences\": {\n \"analytics\": true,\n \"marketing\": false,\n \"functional\": true\n },\n \"policy_version\": 3,\n \"ip_address\": \"200.150.100.50\",\n \"user_agent\": \"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15\"\n}"
response = http.request(request)
puts response.read_body{
"id": "01HK8VV4P9R3T8M2A2YZJ7HQ5Q",
"site_id": "6b8b4567-327a-4d10-92a5-9e8c4f5a7d12",
"subject_id": "user_sha256_a1b2c3d4e5f6",
"consent_id": "analytics-2026-05",
"accepted": true,
"preferences": {
"analytics": true,
"marketing": false,
"functional": true
},
"policy_version": 3,
"country": "BR",
"region": "SP",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15",
"created_at": "2026-05-24T10:30:00Z",
"updated_at": "2026-05-24T10:30:00Z",
"deleted_at": null
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}{
"error": "unauthorized",
"message": "Invalid or missing API key"
}Authorizations
Autenticação por API Key no formato Authorization: Bearer sk-...
(sempre inclua o prefixo Bearer).
Gere sua chave em /dashboard/api-keys após criar a conta e
verificar o e-mail. A chave é exibida uma única vez no momento
da criação — armazene em variável de ambiente no seu backend.
Nunca exponha em código client-side.
Body
application/json
Consent payload
Corpo para criar um consentimento via API server-to-server.
UUID do site (obtido em /dashboard/sites).
Example:
"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12"
Identificador opaco do titular (recomendado hash SHA-256).
Example:
"user_sha256_a1b2c3d4e5f6"
Identificador semântico opcional fornecido pelo cliente.
Example:
"analytics-2026-05"
Aceite do titular.
Example:
true
Preferências por categoria de cookies.
Show child attributes
Show child attributes
Example:
{
"analytics": true,
"marketing": false,
"functional": true
}
Versão da política vigente. Se omitido, usamos a versão ativa do site.
Example:
3
IP de origem (usado só para derivar country/region; não persistido).
Example:
"200.150.100.50"
User-agent do titular.
Example:
"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15"
Response
Created
Registro de consentimento auditável do ConsentFly.
Identificador único do consentimento (ULID gerado pelo servidor).
Example:
"01HK8VV4P9R3T8M2A2YZJ7HQ5Q"
UUID do site dono deste consentimento.
Example:
"6b8b4567-327a-4d10-92a5-9e8c4f5a7d12"
Identificador opaco do titular (recomendado hash SHA-256 do e-mail/ID interno).
Example:
"user_sha256_a1b2c3d4e5f6"
Identificador semântico opcional fornecido pelo cliente (ex. analytics-2026-05).
Example:
"analytics-2026-05"
true se o titular aceitou, false se recusou.
Example:
true
Mapa de categorias de cookies (chave → aceito/recusado).
Show child attributes
Show child attributes
Example:
{
"analytics": true,
"marketing": false,
"functional": true
}
Versão da política de privacidade vigente no momento do consentimento.
Example:
3
País ISO 3166-1 alpha-2 derivado do IP. Não persistimos o IP bruto.
Example:
"BR"
Região/UF derivada do IP (granularidade administrativa).
Example:
"SP"
User-agent do navegador do titular no momento da captura.
Example:
"Mozilla/5.0 (Macintosh; Intel Mac OS X 14_4) AppleWebKit/605.1.15"
Timestamp ISO 8601 UTC da criação.
Example:
"2026-05-24T10:30:00Z"
Timestamp ISO 8601 UTC da última alteração.
Example:
"2026-05-24T10:30:00Z"
Preenchido em soft-delete (LGPD direito ao esquecimento); null quando ativo.
Example:
null