The main endpoint is accessed by an authenticated POST request to /lookup by providing, in the body of the request, at least one of: user identifier value (uid) or a combination of IP address (ip) and User Agent (ua).
All payload parameters are strings and optional, however either uid or ip must have a value or the result will be 400 Bad Request. Also, matching coverage will drop significantly if not all parameters are provided.
The format of the parameter should correspond with the raw data sent for batch processing, for example, if the IP address is hashed in batch delivery, it should be identically hashed for lookup requests. If this isn't possible, the hashing mechanism must be re-implemented on this service.
$.post('https://frankfurt.rt.s6.io/v1/lookup',
data: {
uid: '12345',
ip: '1.2.3.4',
ua: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/62.0.3202.94 Safari/537.36'
},
dataType: 'json',
success: function(data) {
console.log(data.matchid);
console.log("Match provided with confidence; " + data.confidence);
},
beforeSend: function (xhr) {
xhr.setRequestHeader('Authorization', <Bearer Authorization Token>);
},
error: function (data, error) {
console.log(data);
}
);
Results
If the uid was associated with a MatchID in batch processing, the MatchID will be returned with full confidence (1.0).
If a MatchID is not found, the provided parameters and the matching history of the batch graph will be used to associate the uid to an existing MatchID. If that's successful, the MatchID will be returned with a confidence score ranging from 0 to 1.0
If a MatchID is still not obtained, one will be generated with full confidence (1.0). Future requests for this uid will return the same MatchID.