Integrity Check Result

Integrity Check Results record the outcome of a fraud or authenticity assessment against a product code. A result captures whether a code appears legitimate or fraudulent, along with supporting context such as the originating scan event, the product involved, and the geographic location of the object at the time of the check.

The integrity_check_result Object

Field Name	Type	Description
id	uuid	Primary key for the integrity check result.
user_created	object	User who created the record. Read-only.
date_created	datetime	Timestamp in ISO 8601 when the record was created. Read-only.
user_updated	object	User who last updated the record. Read-only.
date_updated	datetime	Timestamp in ISO 8601 when the record was last updated. Read-only.
status	string	Workflow status of the result. One of: new, reviewed, dismissed.
result	string	The verdict of the integrity check. One of: ok, unrecognized, unactivated, duplicated, diverted.
check_source	string	What triggered the check. One of: crowd_sourced, inspector.
reason	string	Explanation of why this result was reached.
review_comments	string	Free-text comments added during manual review.
code	string	Internal code reference associated with this result.
source_scan	object	The Scan Event that triggered this integrity check, if applicable.
product	object	The product associated with the code being checked.
object_location	object	Geographic location data of the object at the time of the check (GeoJSON or coordinate object).

---

Sub-Objects

User Object (user_created, user_updated)

See Users for the full schema.

Scan Event Object (source_scan)

See Scan Events for the full schema.

Product Object (product)

See Product for the full schema.

---

List Integrity Check Results

REST

GET /items/integrity_check_result

GraphQL

query {
  integrity_check_result {
    id
    status
    result
    check_source
    reason
    date_created
    product {
      id
      product_name
    }
    source_scan {
      id
      scan_date
      country
      gtin
      serial
    }
  }
}

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit integrity check result objects. If no items are available, data will be an empty array.

---

Retrieve an Integrity Check Result

REST

GET /items/integrity_check_result/:id

GraphQL

query {
  integrity_check_result_by_id(id: "integrity_check_result_id") {
    id
    status
    result
    check_source
    reason
    review_comments
    code
    object_location
    product {
      id
      product_name
    }
    source_scan {
      id
      scan_date
      country
      city
      gtin
      serial
      device_type
    }
    user_created {
      id
      first_name
      last_name
    }
    date_created
    user_updated {
      id
      first_name
      last_name
    }
    date_updated
  }
}

Returns

Returns an integrity check result object if a valid primary key was provided.

---

Create an Integrity Check Result

REST

POST /items/integrity_check_result

{
  "status": "open",
  "result": "suspicious",
  "check_source": "consumer_scan",
  "reason": "Code scanned in two different countries within 6 hours",
  "product": "product-uuid",
  "source_scan": "scan-event-uuid"
}

GraphQL

mutation {
  create_integrity_check_result_item(data: {
    status: "open"
    result: "suspicious"
    check_source: "consumer_scan"
    reason: "Code scanned in two different countries within 6 hours"
    product: "product-uuid"
    source_scan: "scan-event-uuid"
  }) {
    id
    result
    status
  }
}

Query Parameters

Supports all global query parameters.

Request Body

A partial integrity check result object.

Returns

Returns the integrity check result object for the created record.

---

Update an Integrity Check Result

REST

PATCH /items/integrity_check_result/:id

{
  "status": "resolved",
  "review_comments": "Confirmed counterfeit — code duplicated by third party distributor"
}

GraphQL

mutation {
  update_integrity_check_result_item(id: "integrity_check_result_id", data: {
    status: "resolved"
    review_comments: "Confirmed counterfeit — code duplicated by third party distributor"
  }) {
    id
    status
    review_comments
  }
}

Query Parameters

Supports all global query parameters.

Request Body

A partial integrity check result object.

Returns

Returns the integrity check result object for the updated record.

---

Delete an Integrity Check Result

REST

DELETE /items/integrity_check_result/:id

GraphQL

mutation {
  delete_integrity_check_result_item(id: "integrity_check_result_id") {
    id
  }
}

Returns

Empty body.