> ## 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 compliance request by ID
> Get a compliance request by id.
## OpenAPI
````yaml https://api.concord.tech/docs/json/site-v1/ get /{projectId}/compliance-requests/{complianceRequestId}
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}/compliance-requests/{complianceRequestId}:
get:
tags:
- Compliance Requests
summary: Get compliance request by ID
description: Get a compliance request by id.
operationId: get_site_v1_projectid_compliance_requests_compliancerequestid
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
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
dataSystemTypeId:
type: string
additionalProperties: false
completed:
type: boolean
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
ipAddress:
type: string
format: ipv4
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
components:
securitySchemes:
SessionAuth:
name: x-session
type: apiKey
in: header
description: ''
````