Skip to main content

Create compliance request(s)

Create new compliance request(s).

Path Parameters
projectId uuid REQUIRED
Request Body REQUIRED
request string REQUIRED

Possible values: [change, delete, view, do_not_sell]

requestDetails
captureUrl string REQUIRED

Possible values: length ≤ 2048, Value must match regular expression ^https?:\/\/(?:www\.)?(?:(?:localhost)|(?:[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z0-9()]{2,6}))(?:[-a-zA-Z0-9()@:%_+.~#?&/=]*)$

userFirstName string

Possible values: length ≤ 128

userLastName string

Possible values: length ≤ 128

userPhoneNumber string

Possible values: length ≤ 128

userEmail email REQUIRED
Responses
201

Default Response

Schema OPTIONAL
createdAt OPTIONAL
updatedAt OPTIONAL
downloadDate integer OPTIONAL
filePurgeDate integer OPTIONAL
files object[] OPTIONAL
accountId string OPTIONAL
apiKey string OPTIONAL
date integer OPTIONAL
dateCreated integer OPTIONAL
details string OPTIONAL
event string OPTIONAL
fileName string

Possible values: length ≤ 255

filePath string OPTIONAL
fileSize number OPTIONAL

Possible values: value ≤ 10485760

id uuid
acknowledgedDate integer OPTIONAL
captureUrl string OPTIONAL
concordId uuid
dataSystemTasks object[] OPTIONAL
dataSystem OPTIONAL
completed boolean
dateCreated integer OPTIONAL
dateUpdated integer OPTIONAL
domain string OPTIONAL
notes string OPTIONAL

Possible values: length ≤ 2048

organization OPTIONAL
project OPTIONAL
preverified boolean OPTIONAL
resolution string OPTIONAL

Possible values: length ≤ 2048

resolvedDate date-time OPTIONAL
request string OPTIONAL

Possible values: [change, delete, view, do_not_sell]

requestDate integer
requestDetails string OPTIONAL
session object OPTIONAL
id uuid OPTIONAL
ipAddress ipv4 OPTIONAL
domain OPTIONAL
geography string OPTIONAL
userAgent string OPTIONAL
status string OPTIONAL

Possible values: [pending_verification, submitted, acknowledged, resolved]

user object OPTIONAL
email email OPTIONAL
firstName string OPTIONAL
lastName string OPTIONAL
phoneNumber string OPTIONAL
verifiedDate integer OPTIONAL
verificationMethod string OPTIONAL

Possible values: [email, sms]

verificationRequestId OPTIONAL
400

Bad request response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string

Description of the error encounted.

401

Unauthorized response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string

The error string for the status code.

message string
403

Forbidden response.

Schema OPTIONAL
statusCode int32

The status code of the request.

error string
message string
404

Not found response.

Schema OPTIONAL
statusCode int32
error string
message string
422

Unprocessable Entity response.

Schema OPTIONAL
statusCode int32
error string
message string

Description of the error encounted.

500

Internal server error response.

Schema OPTIONAL
statusCode int32
error string
message string

Will always be "Internal Server Error"