Skip to main content

API v1.1 to v1.2 Migration Guide

Item Format Changes​

New Item Fields​

  • On items with an invalid result (status.result.id), the following field has been added for all routes: status.result.reason. This indicates the reason that the item was marked as invalid.
  • All items now specify the device's form factor in the activity.form_factor field. The possible values are:
    • "microscopic": For handbag authentications and fingerprint sessions made with the microscopic scanner.
    • "lightbox": For sneaker authentications made with the lightbox.
    • "free_camera": For sneaker authentications and fingerprints made with just the device camera.
  • For sneaker authentications, the text fields text_fields.style_code and text_fields.us_size have been added.

Modified Routes​

Retrieve Authentication Sessions by Entrupy ID​

GET /v1/authentications/{entrupy_id}

In v1.1, this route only returned microscopic bag authentications. In v1.2, this also returns lightbox and free_camera authentications.

Retrieve Authentication Sessions by Customer Item ID (Order ID/SKU)​

GET /v1/lookup/authentications/{lookup_value}

In v1.1, this route only returned microscopic bag authentications which matched the provided lookup_value. In v1.2, this can also be used to lookup lightbox and free_camera authentications.

Search Authentication Sessions​

POST /v1/search/authentications

In v1.1, this route only returned microscopic bag authentications. In v1.2, this also returns lightbox and free_camera authentications. You can search by activity.form_factor to limit your search results.