Reports

1 operation.

POST/api/v1/reports

Report something

Signed inIdempotent

Report a public profile, a shop, a listing or a message on a hold or question. One open report per target; rate limited.

SDK: collector.fileReport()
Key scopes: reports:write(API keys are coming soon)
Headers: Idempotency-KeyX-Request-Id

Request body (required, application/json)

object

kindenumrequired
One ofprofilestorelistinghold_messagequestion_message
idstring (uuid)optional
usernamestringoptionalat most 40 characters
reasonenumrequired
One ofspamscamcounterfeitharassmenthatesexualimpersonationother
notestringoptionalat most 1000 characters

Responses

201Filed for the moderators.
object
- reportobjectrequired
  Fields of report
  idstring (uuid)required
  status"open"required

Errors (400, 401, 404, 409, 422, 429, 500)

400invalid_request invalid_json invalid_idempotency_key own_content
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
invalid_idempotency_key: The Idempotency-Key isn’t 1–255 visible ASCII characters.
own_content: You can’t report your own profile, shop or messages.
401unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
404not_found
not_found: Nothing to report there.
409idempotency_in_progress already_reported
idempotency_in_progress: The first request with this key is still running.
already_reported: You have an open report about it already.
422idempotency_key_reused
idempotency_key_reused: This key was used for a different request.
429rate_limited
rate_limited: Too many reports.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/reports' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.fileReport({ body: { … } });