Skip to main content

API v1.2 to v1.3 Migration Guide

API Versioning Changes​

To clarify API usage and simplify upgrades, we now provide an API Versioning Policy with specific guidelines on breaking versus non-breaking changes.

Please ensure your API clients and webhook endpoints can correctly process updated API responses that are considered non-breaking according to this policy.

Examples of non-breaking changes (which may occur without an API version update) include:

  • Adding new keys to dictionaries in a response.
  • Adding new elements to an array in a response, provided they maintain the same type and format as existing elements.
  • Modifying human-readable display strings (e.g., result.display, timestamp.display). Use the corresponding id field for fixed internal identifiers.

For comprehensive details, refer to the API Versioning Policy.

New API Features​

You can now create webhooks using the Entrupy API. (Note: Webhook documentation needs to be added/linked here if ported).

Item Format Changes​

  • The certificate.preview URL for luxury authentication items now links to a smaller-resolution, shareable certificate image (e.g., https://cert.entrupy.com/M96JT72?format=sharable), replacing the previous ?format=legacy URL.
  • The certificate.site URL for luxury authentication items now points to a website, not an image. Use certificate.preview if you require an image.

New Item Fields​

On authentication items, a new key, activity.product_category, has been added to the activity dictionary. This field differentiates between product types.

  • Current valid values: "luxury" and "sneakers".
  • Additional product categories may be added in the future.

Modified Routes​

Search Authentication Sessions​

POST /v1/search/authentications

Previously, searching could be done using either text_fields.order_id or text_fields.customer_item_id. Searching by order_id is now deprecated. You must use text_fields.customer_item_id in filters.