Skip to main content
POST
Reject a recall match candidate

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
candidate_id
string<shortuuid>
required

Identifier of the candidate.

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

Body

application/json

Why a match is being rejected.

note
string
default:""

Optional reason, kept with the suppression for audit. Longer than 500 characters is refused.

Maximum string length: 500
Pattern: ^[^\x00]{0,500}$

Response

OK

One fuzzy match between a regulator recall and a product your organization owns.

id
string<shortuuid>
required

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}$
recall_id
string<shortuuid>
required

Identifier of the regulator recall the product may be part of.

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

Headline of the regulator's recall notice.

recall_source_system
enum<string>
required

Regulator that issued the recall.

Available options:
FDA,
FSIS,
CPSC,
HEALTH_CANADA,
CFIA,
BRAND_ISSUED
recall_severity
enum<string>
required

Risk classification of the recall.

Available options:
CLASS_I,
CLASS_II,
CLASS_III,
UNKNOWN
gtin
string
required

GTIN of your product the recall may apply to.

product_name
string
required

Name of your product.

brand_name
string
required

Brand the product belongs to.

confidence_score
number
required

Match strength from 0.0 to 1.0; higher is a stronger signal.

reason
string
required

Which signal fired, for example company_name+product_name.

status
string
required

PENDING until reviewed, then APPROVED or REJECTED. A candidate approved against a recall that was withdrawn as published in error comes back REJECTED: always read this field.

created
string<date-time>
required

When the matching engine proposed the candidate.

reviewed_at
string<date-time> | null

When the candidate was reviewed, or null while pending.