Skip to main content
POST
Submit feedback on a result

Authorizations

X-Api-Key
string
header
required

API key created in the web app under API keys. Expired or disabled keys are rejected with 401.

Body

application/json
requestId
string
required

Request ID of the scan result, from the presigned, social or media detail response, or from the web app when viewing the result.

Minimum string length: 1
label
enum<string>
required

Your label for the content.

Available options:
REAL,
SYNTHETIC,
MANIPULATED,
UNKNOWN
feedbackCategory
enum<string>
required

Type of feedback.

Available options:
FALSE_POSITIVE,
FALSE_NEGATIVE,
CONFIRMATION,
OTHER
comment
string

Optional free-text comment, stored as text. If omitted, no comment is stored.

Response

User feedback created

Created feedback record. Field presence may vary with the user profile and the stored result.

id
string<uuid>
required
category
enum<string>
required

The submitted feedbackCategory.

Available options:
FALSE_POSITIVE,
FALSE_NEGATIVE,
CONFIRMATION,
OTHER
institutionId
string
required
userId
string
required
requestId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
text
string | null

The submitted comment; only set when a comment was sent.

label
string | null
userName
string | null
userEmail
string | null
orgName
string | null
mediaType
string | null
mediaViewUrl
string | null
mediaSource
string | null

api or api:<key name> for API submissions; otherwise a value naming how the media was submitted, for example social_link or file_upload.