{
"openapi": "3.1.0",
"info": {
"title": "Concord Site API",
"description": "The Concord Site API provide access to the Concord consent and compliance services on the client side (typically used for website integration).Using this API, our clients can perform the following tasks:
- Record and validate consent events:
- Privacy Policy, ToS, and other legal disclosure consent events.
- Cookie consent events.
- Other custom consent events (email subscriptions, SMS messaging acceptance, and other opt-in/opt-out events).
- Capture and verify compliance requests.
- Identify and update user profiles.
",
"version": "4.32.1",
"contact": {
"email": "support@concord.tech",
"name": "Concord Technologies Inc.",
"url": "https://www.concord.tech"
},
"license": {
"name": "Proprietary",
"url": "https://www.concord.tech/legal/saas-agreement"
},
"termsOfService": "https://www.concord.tech/legal/saas-agreement"
},
"components": {
"securitySchemes": {
"SessionAuth": {
"name": "x-session",
"type": "apiKey",
"in": "header",
"description": ""
}
},
"schemas": {}
},
"paths": {
"/{projectId}/compliance-requests/{complianceRequestId}": {
"get": {
"operationId": "get_site_v1_projectid_compliance_requests_compliancerequestid",
"summary": "Get compliance request by ID",
"tags": [
"Compliance Requests"
],
"description": "Get a compliance request by id.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "complianceRequestId",
"required": true
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"downloadDate": {
"type": "integer"
},
"filePurgeDate": {
"type": "integer"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"date": {
"type": "integer"
},
"dateCreated": {
"type": "integer"
},
"details": {
"type": "string"
},
"event": {
"type": "string"
},
"fileName": {
"type": "string",
"maxLength": 255
},
"filePath": {
"type": "string"
},
"fileSize": {
"type": "number",
"maximum": 10485760
},
"bucket": {
"type": "string"
},
"key": {
"type": "string"
},
"contentType": {
"type": "string"
}
},
"required": [
"fileName"
],
"additionalProperties": false
}
},
"id": {
"type": "string",
"format": "uuid"
},
"acknowledgedDate": {
"type": "integer"
},
"captureUrl": {
"type": "string"
},
"concordId": {
"type": "string",
"format": "uuid"
},
"dataSystemTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataSystem": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"dataSystemTypeId": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"trustCenter": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": "integer"
},
"completedBy": {
"type": "string"
},
"completionRecord": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"required": [
"completed"
],
"additionalProperties": false
}
},
"dateCreated": {
"type": "integer"
},
"dateUpdated": {
"type": "integer"
},
"domain": {
"type": "string"
},
"notes": {
"type": "string",
"maxLength": 2048
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"preverified": {
"type": "boolean"
},
"resolution": {
"type": "string",
"maxLength": 2048
},
"resolutionStatus": {
"type": "string",
"enum": [
"completed",
"no_records_found",
"partially_completed",
"denied",
"withdrawn"
],
"maxLength": 2048
},
"resolvedDate": {
"type": "string",
"format": "date-time"
},
"request": {
"type": "string",
"enum": [
"change",
"delete",
"view",
"do_not_sell"
]
},
"requestDate": {
"type": "integer"
},
"requestDetails": {
"type": "string"
},
"session": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"domain": {
"anyOf": [
{
"enum": [
"localhost"
]
},
{
"type": "string"
}
]
},
"geography": {
"type": "string"
},
"userAgent": {
"type": "string"
}
},
"additionalProperties": false
},
"status": {
"type": "string",
"enum": [
"pending_verification",
"submitted",
"acknowledged",
"resolved"
]
},
"user": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
},
"additionalProperties": false
},
"verifiedDate": {
"type": "integer"
},
"verificationMethod": {
"type": "string",
"enum": [
"email",
"sms"
]
},
"verificationRequestId": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
}
},
"required": [
"id",
"concordId",
"requestDate"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/compliance-requests": {
"get": {
"operationId": "get_site_v1_projectid_compliance_requests",
"summary": "Get compliance requests",
"tags": [
"Compliance Requests"
],
"description": "Get compliance requests for the current user.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"count": {
"type": "integer"
},
"total": {
"type": "integer"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"concordId": {
"type": "string",
"format": "uuid"
},
"status": {
"type": "string"
},
"request": {
"type": "string"
},
"requestDate": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
}
}
},
"required": [
"offset",
"count",
"total"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
},
"post": {
"operationId": "post_site_v1_projectid_compliance_requests",
"summary": "Create compliance request(s)",
"tags": [
"Compliance Requests"
],
"description": "Create new compliance request(s).",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requests": {
"type": "array",
"minItems": 1,
"items": {
"type": "string",
"enum": [
"change",
"delete",
"view",
"do_not_sell"
]
}
},
"requestDetails": {
"oneOf": [
{
"type": "string"
},
{
"type": "string"
}
]
},
"captureUrl": {
"type": "string",
"maxLength": 2048
},
"userFirstName": {
"type": "string",
"maxLength": 128
},
"userLastName": {
"type": "string",
"maxLength": 128
},
"userPhoneNumber": {
"type": "string",
"maxLength": 128
},
"userEmail": {
"type": "string",
"format": "email"
}
},
"required": [
"requests",
"captureUrl",
"userEmail"
],
"additionalProperties": false
}
}
},
"required": true
},
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"downloadDate": {
"type": "integer"
},
"filePurgeDate": {
"type": "integer"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"date": {
"type": "integer"
},
"dateCreated": {
"type": "integer"
},
"details": {
"type": "string"
},
"event": {
"type": "string"
},
"fileName": {
"type": "string",
"maxLength": 255
},
"filePath": {
"type": "string"
},
"fileSize": {
"type": "number",
"maximum": 10485760
},
"bucket": {
"type": "string"
},
"key": {
"type": "string"
},
"contentType": {
"type": "string"
}
},
"required": [
"fileName"
],
"additionalProperties": false
}
},
"id": {
"type": "string",
"format": "uuid"
},
"acknowledgedDate": {
"type": "integer"
},
"captureUrl": {
"type": "string"
},
"concordId": {
"type": "string",
"format": "uuid"
},
"dataSystemTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataSystem": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"dataSystemTypeId": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"trustCenter": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": "integer"
},
"completedBy": {
"type": "string"
},
"completionRecord": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"required": [
"completed"
],
"additionalProperties": false
}
},
"dateCreated": {
"type": "integer"
},
"dateUpdated": {
"type": "integer"
},
"domain": {
"type": "string"
},
"notes": {
"type": "string",
"maxLength": 2048
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"preverified": {
"type": "boolean"
},
"resolution": {
"type": "string",
"maxLength": 2048
},
"resolutionStatus": {
"type": "string",
"enum": [
"completed",
"no_records_found",
"partially_completed",
"denied",
"withdrawn"
],
"maxLength": 2048
},
"resolvedDate": {
"type": "string",
"format": "date-time"
},
"request": {
"type": "string",
"enum": [
"change",
"delete",
"view",
"do_not_sell"
]
},
"requestDate": {
"type": "integer"
},
"requestDetails": {
"type": "string"
},
"session": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"domain": {
"anyOf": [
{
"enum": [
"localhost"
]
},
{
"type": "string"
}
]
},
"geography": {
"type": "string"
},
"userAgent": {
"type": "string"
}
},
"additionalProperties": false
},
"status": {
"type": "string",
"enum": [
"pending_verification",
"submitted",
"acknowledged",
"resolved"
]
},
"user": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
},
"additionalProperties": false
},
"verifiedDate": {
"type": "integer"
},
"verificationMethod": {
"type": "string",
"enum": [
"email",
"sms"
]
},
"verificationRequestId": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
}
},
"required": [
"id",
"concordId",
"requestDate"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/compliance-requests/{id}/send-details": {
"post": {
"operationId": "post_site_v1_projectid_compliance_requests_id_send_details",
"summary": "Send compliance details",
"tags": [
"Compliance Requests"
],
"description": "Send compliance details for a compliance request.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/compliance-requests/{id}/verify/{token}": {
"post": {
"operationId": "post_site_v1_projectid_compliance_requests_id_verify_token",
"summary": "Verify compliance request with token",
"tags": [
"Compliance Requests"
],
"description": "Verify a compliance request using a token.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "token",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"downloadDate": {
"type": "integer"
},
"filePurgeDate": {
"type": "integer"
},
"files": {
"type": "array",
"items": {
"type": "object",
"properties": {
"accountId": {
"type": "string"
},
"apiKey": {
"type": "string"
},
"date": {
"type": "integer"
},
"dateCreated": {
"type": "integer"
},
"details": {
"type": "string"
},
"event": {
"type": "string"
},
"fileName": {
"type": "string",
"maxLength": 255
},
"filePath": {
"type": "string"
},
"fileSize": {
"type": "number",
"maximum": 10485760
},
"bucket": {
"type": "string"
},
"key": {
"type": "string"
},
"contentType": {
"type": "string"
}
},
"required": [
"fileName"
],
"additionalProperties": false
}
},
"id": {
"type": "string",
"format": "uuid"
},
"acknowledgedDate": {
"type": "integer"
},
"captureUrl": {
"type": "string"
},
"concordId": {
"type": "string",
"format": "uuid"
},
"dataSystemTasks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dataSystem": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"icon": {
"type": "string"
},
"dataSystemTypeId": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"trustCenter": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"completed": {
"type": "boolean"
},
"completedAt": {
"type": "integer"
},
"completedBy": {
"type": "string"
},
"completionRecord": {
"type": "object",
"properties": {},
"additionalProperties": true
}
},
"required": [
"completed"
],
"additionalProperties": false
}
},
"dateCreated": {
"type": "integer"
},
"dateUpdated": {
"type": "integer"
},
"domain": {
"type": "string"
},
"notes": {
"type": "string",
"maxLength": 2048
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"preverified": {
"type": "boolean"
},
"resolution": {
"type": "string",
"maxLength": 2048
},
"resolutionStatus": {
"type": "string",
"enum": [
"completed",
"no_records_found",
"partially_completed",
"denied",
"withdrawn"
],
"maxLength": 2048
},
"resolvedDate": {
"type": "string",
"format": "date-time"
},
"request": {
"type": "string",
"enum": [
"change",
"delete",
"view",
"do_not_sell"
]
},
"requestDate": {
"type": "integer"
},
"requestDetails": {
"type": "string"
},
"session": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"domain": {
"anyOf": [
{
"enum": [
"localhost"
]
},
{
"type": "string"
}
]
},
"geography": {
"type": "string"
},
"userAgent": {
"type": "string"
}
},
"additionalProperties": false
},
"status": {
"type": "string",
"enum": [
"pending_verification",
"submitted",
"acknowledged",
"resolved"
]
},
"user": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
},
"additionalProperties": false
},
"verifiedDate": {
"type": "integer"
},
"verificationMethod": {
"type": "string",
"enum": [
"email",
"sms"
]
},
"verificationRequestId": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
}
},
"required": [
"id",
"concordId",
"requestDate"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/consent-events": {
"post": {
"operationId": "post_site_v1_projectid_consent_events",
"summary": "Create consent event(s)",
"tags": [
"Consent Events"
],
"description": "Create consent event(s) for the current user.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"consentType": {
"type": "string",
"format": "uuid"
},
"category": {
"anyOf": [
{
"type": "string",
"enum": [
"disclosure",
"communication",
"privacy_setting",
"custom"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"subcategory": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"privacy_policy",
"terms_of_service",
"cookie_policy",
"data_protection_agreement"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"email",
"phone"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"analytics",
"do_not_sell",
"functional",
"global_privacy_control",
"limit_pii_use",
"marketing",
"strictly_necessary",
"unclassified"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"label": {
"type": "string"
},
"consentState": {
"type": "string",
"enum": [
"implied",
"viewed",
"accepted",
"declined"
]
},
"consentAction": {
"type": "string",
"enum": [
"implied",
"user_click"
]
}
},
"required": [
"consentState",
"consentAction"
],
"additionalProperties": false
}
}
},
"required": [
"items"
],
"additionalProperties": false
}
}
},
"required": true
},
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "number"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"id": {
"type": "string",
"format": "uuid"
},
"concordId": {
"type": "string",
"format": "uuid"
},
"consentAction": {
"type": "string",
"enum": [
"implied",
"user_click"
]
},
"consentDate": {
"type": "string",
"format": "date-time"
},
"consentState": {
"type": "string",
"enum": [
"implied",
"viewed",
"accepted",
"declined"
]
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateUpdated": {
"type": "string",
"format": "date-time"
},
"consentType": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"id": {
"type": "string",
"format": "uuid"
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"category": {
"anyOf": [
{
"type": "string",
"enum": [
"disclosure",
"communication",
"privacy_setting",
"custom"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"subcategory": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"privacy_policy",
"terms_of_service",
"cookie_policy",
"data_protection_agreement"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"email",
"phone"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"analytics",
"do_not_sell",
"functional",
"global_privacy_control",
"limit_pii_use",
"marketing",
"strictly_necessary",
"unclassified"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"label": {
"type": "string",
"maxLength": 128,
"pattern": "[a-z0-9_*]{1,128}$"
},
"version": {
"type": "integer"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateUpdated": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 2000
},
"document": {
"type": "string",
"maxLength": 5000000
},
"url": {
"type": "string",
"format": "uri"
},
"readOnly": {
"type": "boolean",
"default": false
},
"validStates": {
"type": "array",
"items": {
"type": "string",
"enum": [
"implied",
"viewed",
"accepted",
"declined"
]
}
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"obsolete",
"test"
]
},
"consentDuration": {
"type": "string"
},
"required": {
"type": "boolean",
"default": false
},
"requireReacceptVersion": {
"type": "integer"
}
},
"required": [
"id",
"project",
"version",
"name",
"description"
],
"additionalProperties": false
}
]
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"session": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"domain": {
"anyOf": [
{
"enum": [
"localhost"
]
},
{
"type": "string"
}
]
},
"geography": {
"type": "string"
},
"userAgent": {
"type": "string"
}
},
"additionalProperties": false
},
"submitter": {
"type": "string",
"format": "uuid"
},
"category": {
"anyOf": [
{
"type": "string",
"enum": [
"disclosure",
"communication",
"privacy_setting",
"custom"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"subcategory": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"privacy_policy",
"terms_of_service",
"cookie_policy",
"data_protection_agreement"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"email",
"phone"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"analytics",
"do_not_sell",
"functional",
"global_privacy_control",
"limit_pii_use",
"marketing",
"strictly_necessary",
"unclassified"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"label": {
"type": "string",
"maxLength": 128,
"pattern": "[a-z0-9_*]{1,128}$"
},
"version": {
"type": "integer"
}
},
"required": [
"id",
"concordId",
"consentAction",
"consentDate",
"consentState",
"expirationDate"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
},
"get": {
"operationId": "get_site_v1_projectid_consent_events",
"summary": "Get consent events",
"tags": [
"Consent Events"
],
"description": "Get consent events for the current user.",
"parameters": [
{
"schema": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$"
},
"in": "query",
"name": "startDate",
"required": false
},
{
"schema": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$"
},
"in": "query",
"name": "endDate",
"required": false
},
{
"schema": {
"default": 0,
"type": "number",
"minimum": 0
},
"in": "query",
"name": "offset",
"required": false
},
{
"schema": {
"default": 100,
"type": "number",
"minimum": 1,
"maximum": 1000
},
"in": "query",
"name": "limit",
"required": false
},
{
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"offset": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"count": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"total": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"items": {
"type": "array",
"items": {}
}
},
"required": [
"offset",
"count",
"total"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/consent-events/{id}": {
"get": {
"operationId": "get_site_v1_projectid_consent_events_id",
"summary": "Get consent event by ID",
"tags": [
"Consent Events"
],
"description": "Get a consent event by ID.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "id",
"required": true
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"id": {
"type": "string",
"format": "uuid"
},
"concordId": {
"type": "string",
"format": "uuid"
},
"consentAction": {
"type": "string",
"enum": [
"implied",
"user_click"
]
},
"consentDate": {
"type": "string",
"format": "date-time"
},
"consentState": {
"type": "string",
"enum": [
"implied",
"viewed",
"accepted",
"declined"
]
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateUpdated": {
"type": "string",
"format": "date-time"
},
"consentType": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"id": {
"type": "string",
"format": "uuid"
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"category": {
"anyOf": [
{
"type": "string",
"enum": [
"disclosure",
"communication",
"privacy_setting",
"custom"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"subcategory": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"privacy_policy",
"terms_of_service",
"cookie_policy",
"data_protection_agreement"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"email",
"phone"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"analytics",
"do_not_sell",
"functional",
"global_privacy_control",
"limit_pii_use",
"marketing",
"strictly_necessary",
"unclassified"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"label": {
"type": "string",
"maxLength": 128,
"pattern": "[a-z0-9_*]{1,128}$"
},
"version": {
"type": "integer"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateUpdated": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 2000
},
"document": {
"type": "string",
"maxLength": 5000000
},
"url": {
"type": "string",
"format": "uri"
},
"readOnly": {
"type": "boolean",
"default": false
},
"validStates": {
"type": "array",
"items": {
"type": "string",
"enum": [
"implied",
"viewed",
"accepted",
"declined"
]
}
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"obsolete",
"test"
]
},
"consentDuration": {
"type": "string"
},
"required": {
"type": "boolean",
"default": false
},
"requireReacceptVersion": {
"type": "integer"
}
},
"required": [
"id",
"project",
"version",
"name",
"description"
],
"additionalProperties": false
}
]
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"session": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"domain": {
"anyOf": [
{
"enum": [
"localhost"
]
},
{
"type": "string"
}
]
},
"geography": {
"type": "string"
},
"userAgent": {
"type": "string"
}
},
"additionalProperties": false
},
"submitter": {
"type": "string",
"format": "uuid"
},
"category": {
"anyOf": [
{
"type": "string",
"enum": [
"disclosure",
"communication",
"privacy_setting",
"custom"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"subcategory": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"privacy_policy",
"terms_of_service",
"cookie_policy",
"data_protection_agreement"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"email",
"phone"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"analytics",
"do_not_sell",
"functional",
"global_privacy_control",
"limit_pii_use",
"marketing",
"strictly_necessary",
"unclassified"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"label": {
"type": "string",
"maxLength": 128,
"pattern": "[a-z0-9_*]{1,128}$"
},
"version": {
"type": "integer"
}
},
"required": [
"id",
"concordId",
"consentAction",
"consentDate",
"consentState",
"expirationDate"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/consent-state": {
"get": {
"operationId": "get_site_v1_projectid_consent_state",
"summary": "Get consent state",
"tags": [
"Consent State"
],
"description": "Get the current consent state for the current user.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "query",
"name": "regionId",
"required": false
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"items": {
"type": "array",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"concordId": {
"type": "string",
"format": "uuid"
},
"consentState": {
"type": "string"
},
"consentAction": {
"type": "string"
},
"consentDate": {
"type": "string",
"format": "date-time"
},
"consentType": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"category": {
"type": "string"
},
"subcategory": {
"type": "string"
},
"label": {
"type": "string"
},
"version": {
"type": "integer"
},
"validStates": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"category": {
"type": "string"
},
"subcategory": {
"type": "string"
},
"label": {
"type": "string"
},
"version": {
"type": "integer"
},
"url": {
"type": "string"
}
},
"additionalProperties": false
}
}
},
"required": [
"count",
"items"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/consent-types": {
"get": {
"operationId": "get_site_v1_projectid_consent_types",
"summary": "Get consent types",
"tags": [
"Consent Types"
],
"description": "Get the consent types for the current project.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"offset": {
"type": "integer"
},
"count": {
"type": "integer"
},
"total": {
"type": "integer"
},
"items": {
"type": "array",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"createdAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"updatedAt": {
"oneOf": [
{
"type": "array",
"items": {}
},
{
"type": "boolean"
},
{
"type": "number"
},
{
"type": "object"
},
{
"type": "string"
}
]
},
"id": {
"type": "string",
"format": "uuid"
},
"organization": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"project": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
}
]
},
"category": {
"anyOf": [
{
"type": "string",
"enum": [
"disclosure",
"communication",
"privacy_setting",
"custom"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"subcategory": {
"anyOf": [
{
"anyOf": [
{
"type": "string",
"enum": [
"privacy_policy",
"terms_of_service",
"cookie_policy",
"data_protection_agreement"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"email",
"phone"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"enum": [
"analytics",
"do_not_sell",
"functional",
"global_privacy_control",
"limit_pii_use",
"marketing",
"strictly_necessary",
"unclassified"
],
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"anyOf": [
{
"type": "string",
"maxLength": 128
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_*]{1,121}$"
}
]
},
{
"type": "string",
"maxLength": 128,
"pattern": "^custom_[a-z0-9_]{1,121}$"
}
]
},
"label": {
"type": "string",
"maxLength": 128,
"pattern": "[a-z0-9_*]{1,128}$"
},
"version": {
"type": "integer"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateUpdated": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"maxLength": 100
},
"description": {
"type": "string",
"maxLength": 2000
},
"document": {
"type": "string",
"maxLength": 5000000
},
"url": {
"type": "string",
"format": "uri"
},
"readOnly": {
"type": "boolean",
"default": false
},
"validStates": {
"type": "array",
"items": {
"type": "string",
"enum": [
"implied",
"viewed",
"accepted",
"declined"
]
}
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"obsolete",
"test"
]
},
"consentDuration": {
"type": "string"
},
"required": {
"type": "boolean",
"default": false
},
"requireReacceptVersion": {
"type": "integer"
}
},
"required": [
"id",
"project",
"version",
"name",
"description"
],
"additionalProperties": false
}
}
},
"required": [
"offset",
"count",
"total",
"items"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/health-check": {
"get": {
"operationId": "get_site_v1_health_check",
"summary": "Health check",
"tags": [
"Health Check"
],
"description": "Health check for the API.",
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": true
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/identify": {
"post": {
"operationId": "post_site_v1_projectid_identify",
"summary": "Identify the current user",
"tags": [
"Identity"
],
"description": "Identify the current session user by email or contextId. If a matching identity is found, merges the current identity into the matched one and returns synced consent state.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"email",
"contextId",
"userId"
]
},
"value": {
"type": "string"
},
"format": {
"type": "string",
"default": "plain",
"enum": [
"plain",
"hashed"
]
},
"token": {
"type": "string",
"description": "JWT token for authenticated identify"
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
}
}
},
"required": true
},
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"synced": {
"type": "boolean"
},
"session": {
"type": "string"
}
},
"required": [
"synced"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"enum": [
401
]
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
},
"403": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"enum": [
403
]
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/session": {
"get": {
"operationId": "get_site_v1_projectid_session",
"summary": "Get session token",
"tags": [
"Session"
],
"description": "Get a session token for the current user.",
"parameters": [
{
"schema": {
"type": "string"
},
"in": "query",
"name": "domain",
"required": false
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "useragent",
"required": false
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "query",
"name": "organizationId",
"required": false
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/{fileName}": {
"get": {
"operationId": "get_site_v1_projectid_filename",
"summary": "Get site client files",
"tags": [
"Site Client"
],
"description": "Get the site client bundle files.",
"parameters": [
{
"schema": {
"type": "string"
},
"in": "path",
"name": "fileName",
"required": true
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/tcf/tc-data": {
"get": {
"operationId": "get_site_v1_projectid_tcf_tc_data",
"summary": "Get TC string data",
"tags": [
"TCF"
],
"description": "Retrieve TCF transparency and consent string.",
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tcString": {
"type": "string"
},
"addtlConsent": {
"type": "string"
},
"vendorConsents": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"purposeConsents": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"vendorLegitimateInterests": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"purposeLegitimateInterests": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"specialFeatureOptins": {
"type": "object",
"properties": {},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/tcf/vendor-list": {
"get": {
"operationId": "get_site_v1_projectid_tcf_vendor_list",
"summary": "Get IAB Global Vendor List",
"tags": [
"TCF"
],
"description": "Retrieve the IAB Global Vendor List with enabled vendors and purposes.",
"parameters": [
{
"schema": {
"type": "integer",
"exclusiveMinimum": 0
},
"in": "query",
"name": "vendorListVersion",
"required": false
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"gvl": {
"oneOf": [
{
"type": "object"
}
]
}
},
"required": [
"gvl"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/tcf/update-consent": {
"post": {
"operationId": "post_site_v1_projectid_tcf_update_consent",
"summary": "Update TCF consent data",
"tags": [
"TCF"
],
"description": "Update user consent data with TC string, AC string, and individual consent choices.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tcString": {
"type": "string"
},
"addtlConsent": {
"type": "string"
},
"vendorConsents": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"purposeConsents": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"vendorLegitimateInterests": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"purposeLegitimateInterests": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"specialFeatureOptins": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"publisherRestrictions": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"gdprApplies": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean"
},
"tcString": {
"type": "string"
},
"addtlConsent": {
"type": "string"
},
"vendorConsents": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"purposeConsents": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"vendorLegitimateInterests": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"purposeLegitimateInterests": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"specialFeatureOptins": {
"type": "object",
"properties": {},
"additionalProperties": false
},
"updatedAt": {
"type": "integer"
}
},
"required": [
"success",
"updatedAt"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
},
"/{projectId}/tcf/purposes": {
"get": {
"operationId": "get_site_v1_projectid_tcf_purposes",
"summary": "Get IAB purposes",
"tags": [
"TCF"
],
"description": "Retrieve IAB purposes for TCF compliance.",
"parameters": [
{
"schema": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "string"
}
]
},
"in": "query",
"name": "purposeIds",
"required": false
},
{
"schema": {
"type": "string",
"format": "uuid"
},
"in": "path",
"name": "projectId",
"required": true
}
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"purposes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"descriptionLegal": {
"type": "string"
},
"illustrations": {
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
},
"required": [
"id",
"name",
"description"
],
"additionalProperties": false
}
},
"count": {
"type": "integer",
"minimum": 0
}
},
"required": [
"purposes",
"count"
],
"additionalProperties": false
}
}
}
},
"400": {
"description": "Bad request response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"401": {
"description": "Unauthorized response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Not Found",
"description": "The error string for the status code."
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"403": {
"description": "Forbidden response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 403,
"description": "The status code of the request."
},
"error": {
"type": "string",
"default": "Forbidden"
},
"message": {
"type": "string",
"default": "Forbidden"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"404": {
"description": "Not found response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 404
},
"error": {
"type": "string",
"default": "Not Found"
},
"message": {
"type": "string",
"default": "Not Found"
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"422": {
"description": "Unprocessable Entity response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 422
},
"error": {
"type": "string",
"default": "Unprocessable Entity"
},
"message": {
"type": "string",
"description": "Description of the error encounted."
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
},
"500": {
"description": "Internal server error response.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"format": "int32",
"default": 500
},
"error": {
"type": "string",
"default": "Internal Server Error"
},
"message": {
"type": "string",
"default": "Internal Server Error",
"description": "Will always be \"Internal Server Error\""
}
},
"required": [
"statusCode",
"error",
"message"
]
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://api.concord.tech/site-v1",
"description": "Concord Site API"
}
],
"security": [
{
"SessionAuth": []
}
],
"tags": [
{
"name": "Compliance Requests",
"description": "Compliance request endpoints."
},
{
"name": "Consent Events",
"description": "Consent event endpoints."
},
{
"name": "Consent State",
"description": "Consent state endpoints."
},
{
"name": "Consent Types",
"description": "Consent type endpoints."
},
{
"name": "Health Check",
"description": "Health Check endpoints."
},
{
"name": "Identity",
"description": "Identity endpoints."
},
{
"name": "Profile",
"description": "User profile endpoints."
},
{
"name": "Session",
"description": "Session endpoints."
},
{
"name": "Site Client",
"description": "Site client endpoints."
},
{
"name": "Site Widget",
"description": "Site widget endpoints."
},
{
"name": "Trackers",
"description": "Tracker endpoints."
},
{
"name": "TCF",
"description": "TCF endpoints."
}
]
}