Skip to main content
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": {},
  "comments": "<string>",
  "receivedAt": "2023-11-07T05:31:56Z",
  "validUntil": "2023-11-07T05:31:56Z"
}
'
{
  "id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.

Body

application/json
​
candidateId
string
required
Minimum string length: 1
​
framework
enum<string>
required

The regulatory framework

Available options:
GDPR,
PDPO
​
legalBasis
enum<string>
required

The legal basis for the consent

Available options:
CONSENT,
CONTRACT,
LEGAL_OBLIGATION,
VITAL_INTEREST,
PUBLIC_TASK,
LEGITIMATE_INTEREST
​
purpose
object
required

The purpose of the consent

​
comments
string | null
required

Free text field for additional comments

Minimum string length: 1
​
receivedAt
required
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))$
​
validUntil
required
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.

​
id
string
required
Minimum string length: 1