> ## Documentation Index
> Fetch the complete documentation index at: https://developers.concord.tech/llms.txt
> Use this file to discover all available pages before exploring further.
# Get consent state
> Get the current consent state for the current user.
## OpenAPI
````yaml https://api.concord.tech/docs/json/site-v1/ get /{projectId}/consent-state
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: 3.29.6
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
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: 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.
paths:
/{projectId}/consent-state:
get:
tags:
- Consent State
summary: Get consent state
description: Get the current consent state for the current user.
operationId: get_site_v1_projectid_consent_state
parameters:
- 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:
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
- import
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:
oneOf:
- type: array
items: {}
- type: boolean
- type: number
- type: object
- type: string
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
ipAddress:
type: string
format: ipv4
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:
oneOf:
- type: array
items: {}
- type: boolean
- type: number
- type: object
- type: string
label:
type: string
maxLength: 128
pattern: '[a-z0-9_*]{1,128}$'
version:
type: integer
required:
- id
- concordId
- consentAction
- consentDate
- consentState
- expirationDate
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
components:
securitySchemes:
SessionAuth:
name: x-session
type: apiKey
in: header
description: ''
````