Data Model (v1.4)

Welcome to the Entrupy API!

Overview

This API exposes various metadata for authentications submitted to the Entrupy authentication service.

Entrupy ID (entrupy_id)

This is the unique identifier for each authentication.

Owner (owner)

Information about who performed the authentication.

• organization.name: The authenticator's organization name.
• user.username: The authenticator's username.

Certificate (certificate)

The item's certificate URL, if applicable. Certificates are only issued for items that are authentic.

• site: The URL for the certificate website.
• preview: This links to an image version of the certificate, which matches what you see in the authentication app.

Properties (properties)

An item's properties describe what the item is. These values are selected when a user authenticates an item and show up on an authentic item's certificate.

• brand.id: This field is an identifier for the authenticated item's brand.
• brand.display: A localized translation of brand.id, determined by the Accept-Language header.
• material.id: This optional field corresponds to the material of the authenticated item, and is only present for luxury authentications. Some of these are a specific type or pattern of material, while others such as leather or canvas are more generic.
• material.display: A localized translation of material.id, determined by the Accept-Language header.
• item_type.id: This optional field identifies the type of apparel item (such as tops, dresses, etc), and is only present for apparel authentications.
• item_type.display: A localized translation of item_type.id, determined by the Accept-Language header.

Status (status)

An item's status contains fields that can change over time for an item.

• flag: Users are able to flag authentications to the Entrupy Support team via the mobile app if they have questions about the result or other issues. Once the Entrupy Support team responds to the flag, the authentication will be marked as resolved. The possible values for this field are null, "flagged", or "resolved".
• result.id: Entrupy's result for the given authentication - This is a fixed identifier which does not change based on the Accept-Language header.
• result.display: Entrupy's result for the given authentication - This is a human readable display string and will change based on the Accept-Language header.
• result.final: Whether or not the given result is final.
• result.reason: On "invalid" items this indicates the reason the item is invalid.

Text Fields (text_fields)

These values are entered in by the user. Some of these fields are properties of the item:

• identifier: The item's date code or serial number, if applicable.

Others are provided by the user for their own record keeping:

• customer_item_id: An optional, custom field that the authenticator uses to identify an item. This is usually a unique barcode, item ID or order ID. In the Entrupy Plus app, this is entered in the SKU field or scanned by the barcode reader during authentication. In the Entrupy FP app, this is the Order ID field. If these values are unique per item, the lookup API call can be used.

On sneaker authentication sessions (with a lightbox or free camera), there are two additional text fields:

• style_code: Identifier for the type of sneaker.
• us_size: The US size of the sneaker.

Timestamp (timestamp)

The timestamp for when the user started the authentication, in two formats:

• display: Human-readable timestamp, in UTC.
• epoch: UNIX epoch (seconds since Jan 1 1970 UTC).

Activity (activity)

Information about method that was used to authenticate or fingerprint the item:

• name: This is either "authentication" or "fingerprint".

• mode: For fingerprint items, whether an item was registered ("register") or compared to an previously registered item ("compare")

• form_factor: This shows what form factor of device was used.

  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 handbag or sneaker authentications and fingerprints made with just the device camera.

• product_category: On authentication items, this is used to differentiate the different types of authentication Entrupy currently supports.

  Currently, the possible values are:

  • "luxury": For handbag authentications
  • "sneakers": For sneaker authentications
  • "apparel": For clothing

Images (images)

When the option format_options__return_item_photos is passed while looking up an authentication, the response will include camera images. For microscopic bag authentication sessions, the camera images are returned. For sneaker authentication, the box_label and size_tag camera images are returned. For apparel authentication, the front camera image is returned.

To uniquely identify an image region, use a composite key with region_id as well as device_type since it's possible to have multiple regions with the same region ID but a different device type.

Value Listing

Properties: Brand/Material

Below are the combinations of values that an item can possibly have.

Luxury Brands:

brand.id: hermes
brand.display: Hermès
material.id: clemence_leather, togo_leather, epsom_leather, box_calf_leather, other
material.display: Clemence Leather, Togo Leather, Epsom Leather, Box Calf Leather, Other

brand.id: chanel
brand.display: Chanel
material.id: smooth_leather, caviar_leather, patent_leather, other
material.display: Calfskin/Lambskin Leather, Caviar Leather, Patent Leather, Other

brand.id: louis_vuitton
brand.display: Louis Vuitton
material.id: monogram_canvas, damier_ebene_canvas, damier_azur_canvas, damier_graphite_canvas, epi_leather, epi_electric_leather, monogram_vernis_leather, monogram_mat_leather, monogram_empreinte_leather, multicolore_canvas, other
material.display: Monogram Canvas, Damier Ebene Canvas, Damier Azur Canvas, Damier Graphite Canvas, Epi Leather, Epi Electric Leather, Monogram Vernis Leather, Monogram Mat Leather, Monogram Empreinte Leather, Multicolore Canvas, Other

brand.id: dior
brand.display: Dior
material.id: canvas, coated_canvas, leather, patent_leather, other
material.display: Canvas, Coated Canvas, Leather, Patent Leather, Other

brand.id: goyard
brand.display: Goyard
material.id: goyardine_canvas
material.display: Goyardine Canvas

brand.id: celine
brand.display: Céline
material.id: other
material.display: Other

brand.id: gucci
brand.display: Gucci
material.id: gg_canvas, gg_supreme_canvas, guccissima_leather, other
material.display: GG Canvas, GG Supreme Canvas, Guccissima Leather, Other

brand.id: fendi
brand.display: Fendi
material.id: canvas, coated_canvas, leather, other
material.display: Canvas, Coated Canvas, Leather, Other

brand.id: bottega_veneta
brand.display: Bottega Veneta
material.id: leather, rubberized_canvas, other
material.display: Leather, Rubberized Canvas, Other

brand.id: yves_saint_laurent
brand.display: Saint Laurent
material.id: leather, other
material.display: Leather, Other

brand.id: burberry
brand.display: Burberry
material.id: canvas, coated_canvas, leather, other
material.display: Canvas, Coated Canvas, Leather, Other

brand.id: balenciaga
brand.display: Balenciaga
material.id: lambskin_leather, goatskin_leather, other
material.display: Lambskin Leather, Goatskin Leather, Other

brand.id: chloe
brand.display: Chloé
material.id: smooth_leather, grained_leather, other
material.display: Smooth Leather, Grained Leather, Other

brand.id: prada
brand.display: Prada
material.id: saffiano_leather, nylon, other
material.display: Saffiano Leather, Nylon, Other

brand.id: coach
brand.display: Coach
material.id: leather, canvas, coated_canvas, signature_jacquard, other
material.display: Leather, Canvas, Coated Canvas, Signature Jacquard, Other

Sneaker Brands:

brand.id: nike
brand.display: Nike

brand.id: jordan
brand.display: Jordan

brand.id: adidas
brand.display: Adidas

brand.id: yeezy
brand.display: Yeezy

brand.id: new_balance
brand.display: New Balance

Apparel Brands:

brand.id: essentials
brand.display: Essentials

Status: Result ID / Display

Possible values for status.result.id and status.result.display (English):

• authentic / "Authentic"
• unidentified / "Unidentified"
• no_decision / "Unable to Determine" (for older items, now deprecated)
• error_processing / "Error Processing" (internal error)
• invalid / "Invalid" (e.g., bad images, test submission)
• registered / "Registered" (for fingerprint registration)
• match / "Match" (for fingerprint comparison)
• no_match / "No Match" (for fingerprint comparison)

Status: Result Reason (for invalid items)

Possible values for status.result.reason when status.result.id is invalid:

• image_quality
• item_not_supported
• damaged_item
• test_submission
• other

Activity: Form Factor

• microscopic
• lightbox
• free_camera

Activity: Product Category

• luxury
• sneakers
• apparel