Create consent
curl --request POST \
--url https://api.gospott.com/consents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"candidateId": "<string>",
"purpose": {
"type": "system"
},
"comments": "<string>",
"receivedAt": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.gospott.com/consents"
payload = {
"candidateId": "<string>",
"purpose": { "type": "system" },
"comments": "<string>",
"receivedAt": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}
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({
candidateId: '<string>',
purpose: {type: 'system'},
comments: '<string>',
receivedAt: '2023-11-07T05:31:56Z',
validUntil: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.gospott.com/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://api.gospott.com/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([
'candidateId' => '<string>',
'purpose' => [
'type' => 'system'
],
'comments' => '<string>',
'receivedAt' => '2023-11-07T05:31:56Z',
'validUntil' => '2023-11-07T05:31:56Z'
]),
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.gospott.com/consents"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"purpose\": {\n \"type\": \"system\"\n },\n \"comments\": \"<string>\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"validUntil\": \"2023-11-07T05:31:56Z\"\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.gospott.com/consents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"purpose\": {\n \"type\": \"system\"\n },\n \"comments\": \"<string>\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"validUntil\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/consents")
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 \"candidateId\": \"<string>\",\n \"purpose\": {\n \"type\": \"system\"\n },\n \"comments\": \"<string>\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"validUntil\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": 0,
"message": "Validation failed: candidateId is required",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Consents
Create consent
Create a new consent record for a candidate. Requires consent details including purpose, legal basis, and validity period.
POST
/
consents
Create consent
curl --request POST \
--url https://api.gospott.com/consents \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"candidateId": "<string>",
"purpose": {
"type": "system"
},
"comments": "<string>",
"receivedAt": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://api.gospott.com/consents"
payload = {
"candidateId": "<string>",
"purpose": { "type": "system" },
"comments": "<string>",
"receivedAt": "2023-11-07T05:31:56Z",
"validUntil": "2023-11-07T05:31:56Z"
}
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({
candidateId: '<string>',
purpose: {type: 'system'},
comments: '<string>',
receivedAt: '2023-11-07T05:31:56Z',
validUntil: '2023-11-07T05:31:56Z'
})
};
fetch('https://api.gospott.com/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://api.gospott.com/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([
'candidateId' => '<string>',
'purpose' => [
'type' => 'system'
],
'comments' => '<string>',
'receivedAt' => '2023-11-07T05:31:56Z',
'validUntil' => '2023-11-07T05:31:56Z'
]),
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.gospott.com/consents"
payload := strings.NewReader("{\n \"candidateId\": \"<string>\",\n \"purpose\": {\n \"type\": \"system\"\n },\n \"comments\": \"<string>\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"validUntil\": \"2023-11-07T05:31:56Z\"\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.gospott.com/consents")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"candidateId\": \"<string>\",\n \"purpose\": {\n \"type\": \"system\"\n },\n \"comments\": \"<string>\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"validUntil\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/consents")
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 \"candidateId\": \"<string>\",\n \"purpose\": {\n \"type\": \"system\"\n },\n \"comments\": \"<string>\",\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"validUntil\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}{
"status": 0,
"message": "Validation failed: candidateId is required",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Authorizations
API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Body
application/json
Minimum string length:
1The regulatory framework
Available options:
GDPR, PDPO The legal basis for the consent
Available options:
CONSENT, CONTRACT, LEGAL_OBLIGATION, VITAL_INTEREST, PUBLIC_TASK, LEGITIMATE_INTEREST The purpose of the consent
- Option 1
- Option 2
Show child attributes
Show child attributes
Free text field for additional comments
Minimum string length:
1Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
Consent created successfully. Returns the consent ID.
Minimum string length:
1Was this page helpful?