Skip to main content
POST
File an adverse report

Authorizations

X-API-Key
string
header
required

Body

application/json

Payload to file a new adverse report (consumer-facing).

gtin
string
required

GTIN of the product the report is about, from the resolution context.

report_type
enum<string>
required

Typed harm category (illness / injury / allergic_reaction / foreign_object / spoilage / packaging_defect).

Available options:
illness,
injury,
allergic_reaction,
foreign_object,
spoilage,
packaging_defect
severity
enum<string> | null

Optional consumer-declared severity (minor / moderate / serious / life_threatening). Omit or null if the consumer declined — Closient never infers it.

Available options:
minor,
moderate,
serious,
life_threatening
body
string
default:""

Freeform description of what happened. May be empty for a voice-only report.

batch
string | null

Batch/lot identifier (GS1 AI 10) from the scan. The lot is the correlation unit for alerts.

voice_session_id
string<shortuuid> | null

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Explicit opt-in to be contacted by the brand about this report.

contact_email
string | null

Contact address the consumer agrees to be reached at. Must be one of their own verified account email addresses. Only meaningful when contact_consent is true.

Response

Created

A filed adverse report as the reporter sees it — the receipt.

Carries the immutable reference id, the report's typed fields, the delivery record, and the prefilled regulator handoff (Closient never files on the consumer's behalf — the handoff is how they complete the real report).

reference_id
string
required

Immutable, human-facing reference the reporter quotes to track it.

id
string<shortuuid>
required

Public short-UUID identifier of the adverse report.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
gtin
string
required

GTIN-14 of the product this report is about.

report_type
enum<string>
required

Typed harm category code.

Available options:
illness,
injury,
allergic_reaction,
foreign_object,
spoilage,
packaging_defect
body
string
required

Freeform description the consumer wrote (may be empty for voice-only).

status
string
required

Underlying signal lifecycle code: active or revoked.

has_voice
boolean
required

True when a voice capture session backs this report.

Whether the consumer opted in to be contacted by the brand.

created
string<date-time>
required

ISO-8601 timestamp the report was filed.

delivery
DeliveryOut · object
required

The immutable delivery record for this report.

Example:
regulator_handoff
RegulatorHandoffOut · object
required

Prefilled handoff to the appropriate regulator — the consumer completes the filing.

Example:
batch
string | null

Batch/lot identifier (GS1 AI 10) from the scan, or null.

serial
string | null

Serialized-unit context from the scan, or null.

severity
enum<string> | null

Consumer-declared severity code, or null if not graded. Never inferred by Closient.

Available options:
minor,
moderate,
serious,
life_threatening