User Management
Generate User Consent
Record user acceptance of terms and conditions and generate a consent ID
POST
/
onboarding
/
api
/
v1
/
tnc
Generate User Consent
curl --request POST \
--url https://api.carbnconnect.com/onboarding/api/v1/tnc \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"tnc_data": {
"tnc_accepted": true,
"accepted_at": "YYYY-MM-DDTHH:MM:SS.sssZ"
}
}
'import requests
url = "https://api.carbnconnect.com/onboarding/api/v1/tnc"
payload = { "tnc_data": {
"tnc_accepted": True,
"accepted_at": "YYYY-MM-DDTHH:MM:SS.sssZ"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({tnc_data: {tnc_accepted: true, accepted_at: 'YYYY-MM-DDTHH:MM:SS.sssZ'}})
};
fetch('https://api.carbnconnect.com/onboarding/api/v1/tnc', 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://api.carbnconnect.com/onboarding/api/v1/tnc",
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([
'tnc_data' => [
'tnc_accepted' => true,
'accepted_at' => 'YYYY-MM-DDTHH:MM:SS.sssZ'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.carbnconnect.com/onboarding/api/v1/tnc"
payload := strings.NewReader("{\n \"tnc_data\": {\n \"tnc_accepted\": true,\n \"accepted_at\": \"YYYY-MM-DDTHH:MM:SS.sssZ\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.carbnconnect.com/onboarding/api/v1/tnc")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tnc_data\": {\n \"tnc_accepted\": true,\n \"accepted_at\": \"YYYY-MM-DDTHH:MM:SS.sssZ\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.carbnconnect.com/onboarding/api/v1/tnc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tnc_data\": {\n \"tnc_accepted\": true,\n \"accepted_at\": \"YYYY-MM-DDTHH:MM:SS.sssZ\"\n }\n}"
response = http.request(request)
puts response.read_body"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"Authorizations
API key for authentication. Must be included in the x-api-key header.
Body
application/json
Show child attributes
Show child attributes
Response
User consent recorded successfully and consent ID generated
The unique consent ID generated for the user's terms and conditions acceptance
Example:
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Previous
Update WebhookUpdate an existing webhook's URL and status. Webhooks are created with 'disabled' status by default and must be enabled using this endpoint.
**Important:** The event category cannot be changed after webhook creation. Only the URL and status can be updated.
**Default Behavior:**
- All webhooks are created with `status: "disabled"`
- Use this endpoint to set `status: "enabled"` to start receiving events
- URL can be updated to change the webhook destination
Next
⌘I
Generate User Consent
curl --request POST \
--url https://api.carbnconnect.com/onboarding/api/v1/tnc \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"tnc_data": {
"tnc_accepted": true,
"accepted_at": "YYYY-MM-DDTHH:MM:SS.sssZ"
}
}
'import requests
url = "https://api.carbnconnect.com/onboarding/api/v1/tnc"
payload = { "tnc_data": {
"tnc_accepted": True,
"accepted_at": "YYYY-MM-DDTHH:MM:SS.sssZ"
} }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({tnc_data: {tnc_accepted: true, accepted_at: 'YYYY-MM-DDTHH:MM:SS.sssZ'}})
};
fetch('https://api.carbnconnect.com/onboarding/api/v1/tnc', 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://api.carbnconnect.com/onboarding/api/v1/tnc",
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([
'tnc_data' => [
'tnc_accepted' => true,
'accepted_at' => 'YYYY-MM-DDTHH:MM:SS.sssZ'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.carbnconnect.com/onboarding/api/v1/tnc"
payload := strings.NewReader("{\n \"tnc_data\": {\n \"tnc_accepted\": true,\n \"accepted_at\": \"YYYY-MM-DDTHH:MM:SS.sssZ\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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://api.carbnconnect.com/onboarding/api/v1/tnc")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"tnc_data\": {\n \"tnc_accepted\": true,\n \"accepted_at\": \"YYYY-MM-DDTHH:MM:SS.sssZ\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.carbnconnect.com/onboarding/api/v1/tnc")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tnc_data\": {\n \"tnc_accepted\": true,\n \"accepted_at\": \"YYYY-MM-DDTHH:MM:SS.sssZ\"\n }\n}"
response = http.request(request)
puts response.read_body"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"