Skip to main content

API v1.0 to v1.1 Migration Guide

Item Format Changes​

Modified Item Fields​

For all routes, the following changes have occurred:

  • The values available for status.result.id have changed. On "Unidentified" items, the value of status.result.id will now be unidentified. Previously, the API returned unknown for these items.
  • The keys text_fields.date_code and text_fields.serial_number have been merged and replaced with text_fields.identifier.
  • The key text_fields.order_id has been renamed to text_fields.customer_item_id.
  • The key properties.model has been renamed to properties.material.

New Item Fields​

All authentication items now have human-readable display keys for properties.brand, properties.material, and status.result, which have been added to the existing output.

For example, if an old result looked like:

"result": { "final": true, "id": "authentic"}

It will now be:

"result": { "display": "Authentic", "final": true, "id": "authentic"}

Note: When making requests to the v1.1 API, you can send an Accept-Language header to determine the language of the display fields (see below).

Request Format Changes​

All requests to the v1.1 API can now include an Accept-Language header, which determines the language in which display fields are presented. Valid options for Accept-Language are en (English) or ja (Japanese).