Enterprise Feature
This feature is available to Enterprise customers upon request
The authentication API is used to analyze Thng scans and other actions and related resources (Purchase order, places, product, etc.) to trigger individual rules that determine an item's likely authentication status. For example, if an item is not activated or is in the wrong country, its status could be "Negative".
Rule Summary
The following rules play a part in determining the authentication status of an item:
- Does the scanned item exist and have a valid format identifier?
- Is the item activated and authorized by the factory?
- Was it found in the correct country/markets as specified at production?
- Is it likely the code found on the packaging was duplicated many times?
- Does the physical item match the digital description in the EVRYTHNG platform?
- Is there a watermark expected, and does it match the same item it's printed on?
- If any brand-specific markings are expected, are they present on the item?
In addition to the API response, an authenticationResults type action is also produced asynchronously for analytical and integration purposes, containing similar information.
API Status
Beta:
/authentication
Jump To↓
AuthenticationTriggeringActionDocument
Assesses the authenticity of the scanned item
AuthenticationTriggeringActionDocument Data Model
The input to an authentication request is the triggering action, containing details of Thng, product, location, tags, context, and additional custom fields required by some rules.
.id (string, read-only, required)
The ID of this resource.
.type (string, required, one of 'inspectorScans', 'implicitScans', 'supplyChainScans', 'scans', 'authenticationConfirmations')
Trigger action type, which varies according to the actor or
app requesting authentication
.customFields (CustomFieldsDocument)
Object of case-sensititve key-value pairs of custom fields
associated with the resource.
.locationSource (string, required, one of 'geoIp', 'sensor', 'unknown')
Source of the location data. Must be `sensor` to specify
custom coordinates.
.location (object, required)
Action location data
.thng (string, read-only)
The ID of this resource.
{
"type": "object",
"description": "The input to an authentication request is the triggering action, containing details of Thng, product, location, tags, context, and additional custom fields required by some rules",
"required": ["id", "type", "location", "locationSource"],
"properties": {
"id": {
"type": "string",
"description": "The ID of this resource.",
"pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
"readOnly": true
},
"type": {
"description": "Trigger action type, which varies according to the actor or app requesting authentication",
"type": "string",
"enum": ["inspectorScans", "implicitScans", "supplyChainScans", "scans", "authenticationConfirmations"]
},
"customFields": {
"type": "object",
"description": "Object of case-sensititve key-value pairs of custom fields associated with the resource."
},
"locationSource": {
"description": "Source of the location data. Must be `sensor` to specify custom coordinates.",
"type": "string",
"enum": ["geoIp", "sensor", "unknown"]
},
"location": {
"description": "Action location data",
"type": "object",
"additionalProperties": false,
"required": ["position", "latitude", "longitude"],
"properties": {
"latitude": { "type": "number" },
"longitude": { "type": "number" },
"position": {
"type": "object",
"required": ["type", "coordinates"],
"properties": {
"type": {
"type": "string",
"enum": ["Point"]
},
"coordinates": {
"type": "array",
"items": { "type": "number" }
}
}
}
}
},
"thng": {
"type": "string",
"description": "The ID of this resource.",
"pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
"readOnly": true
}
}
}
{
"type": "inspectorScans",
"id": "VxQ3BsQcUpeDAGWG4MsHwkBr",
"createdAt": 1643728626635,
"customFields": {
"inspectedProductMatch": "no",
"requestSource": "app",
"requestUser": "VbQGV8tHrnpxwHeQpxk5Bmfs",
"requestUserName": "Brady A"
},
"timestamp": 1643728626635,
"location": {
"latitude": 51.7852,
"longitude": 0.6684,
"position": {
"type": "Point",
"coordinates": [
0.6684,
51.7852
]
}
},
"locationSource": "geoIp",
"thng": "VStmV8tbbwXMRCf6qnYPDQed"
}
Assess the authenticity of a scanned item
Assess the authenticity of a scanned item.
POST /authentication
Content-Type: application/json
Authorization: $OPERATOR_API_KEY
AuthenticationTriggeringActionDocument
curl -i -H Content-Type:application/json \
-H Authorization:$OPERATOR_API_KEY \
-X POST https://api.evrythng.io/v2/authentication \
-d '{
"type": "inspectorScans",
"id": "VcWaed2bwYwEMEf5nAsy5Fbk",
"createdAt": 1649427329485,
"timestamp": 1649427329485,
"customFields": {
"requestUser": "UtdpmMYWNWsPbkSBUQhMCBqf",
"requestUserName": "John D",
"inspectedProductMatch": "yes"
},
"location": {
"latitude": 51.7852,
"longitude": 0.6684,
"position": {
"type": "Point",
"coordinates": [
0.6684,
51.7852
]
}
},
"locationSource": "geoIp",
"thng": "VTCweUhwaEwEqEfpHdsTpkat"
}'
// Create a trigger action
const payload = {
type: 'inspectorScans',
id: 'VcWaed2bwYwEMEf5nAsy5Fbk',
createdAt: 1649427329485,
timestamp: 1649427329485,
customFields: {
requestUser: 'UtdpmMYWNWsPbkSBUQhMCBqf',
requestUserName: 'John D',
inspectedProductMatch: 'yes',
},
location: {
latitude: 51.7852,
longitude: 0.6684,
position: {
type: 'Point',
coordinates: [
0.6684,
51.7852
]
}
},
locationSource: 'geoIp',
thng: 'VTCweUhwaEwEqEfpHdsTpkat'
};
const response = await operator.action('implicitScans').create(payload)
.then(console.log);
// Request authentication
const authResponse = await evrythng.api({
apiUrl: '/authentication',
apiKey: OPERATOR_API_KEY,
method: 'POST',
data: response,
});
console.log(authResponse);
HTTP/1.1 200 OK
Content-Type: application/json
{
"type": "authenticationResults",
"id": "VcpeTe3wywUtATwrhxY2gEdn",
"createdAt": 1655973008891,
"customFields": {
"authenticationStatus": "negative",
"childActions": {
"diversionChecks": {
"match": "unknown",
"reason": "No permitted markets defined"
},
"duplicateChecks": {
"match": "unknown",
"reason": "Invalid ID, no data available"
},
"invalidChecks": {
"match": "true",
"reason": "Item was not found"
},
"unauthorizedChecks": {
"match": "unknown",
"reason": "Invalid ID, no data available"
}
},
"counterfeitStatus": "negative",
"countriesCount": 0,
"duplicateProfile": {
"countryCodes": [],
"geoIpBBSize": 0,
"isDuplicate": false,
"isTriggerOutlier": false,
"regions": [],
"sensorBBSize": 0,
"uaHashes": []
},
"geoIpSpreadDistance": 0,
"geoIpSpreadThreshold": 20,
"grayMarketStatus": "positive",
"maxObservedScans": 50,
"permittedCountries": [],
"previousImplicitScansCount": 0,
"regionsCount": 0,
"regionsThreshold": 2,
"requestSource": "Unknown",
"scanThreshold": 4,
"sensorSpreadDistance": 0,
"sensorSpreadThreshold": 5,
"spreadOutlier": "no",
"spreadOutlierThreshold": 3,
"triggerAction": "VypVyB29CsK5gQEhs8yMEnrp",
"triggerContext": {
"city": "Belgrade",
"countryCode": "RS",
"entryUrl": "https://wrxfq.tn.gg//01/5000157089908",
"region": "Belgrade",
"timeZone": "Europe/Belgrade",
"userAgent": "Mozilla/5.0 (Linux; Android 11; SM-A505FN) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Mobile Safari/537.36"
},
"userAgentCount": 0,
"userAgentsThreshold": 2
},
"tags": [
"brandIntegrity",
"status:negative",
"source:Unknown",
"scanValue:unknown",
"match:invalidChecks",
"eventGroup:counterfeit"
],
"timestamp": 1655973008891,
"location": {
"latitude": 44.804,
"longitude": 20.4651,
"position": {
"type": "Point",
"coordinates": [
20.4651,
44.804
]
}
},
"locationSource": "sensor",
"thng": "Vy3hDhGCgCHGHnVfACQ6NdKh"
}