Profiles Endpoint

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Profiles endpoint is able to serve complete profile data for a user session. Depending on the NeuroID products purchased, the Profiles endpoint will return the appropriate response. The table below outlines which blocks of data are returned for each NeuroID Product.

ProductInteraction AttributesSignals ArraySignal Attributes
ID Crowd AlertN/AN/AN/A
ID OrchestratorNoYesNo
ID AttributesYesYesYes

Interaction Attributes

Customers who have purchased ID Attributes will receive a block of high-level summary statistics for the given session, including session duration, counts of interactions with various field groupings, and cardinalities for session identifiers. These Interaction Attributes are presented within the “profile” block of the API response.

Signals Array

The “signals” block in the API response consists of an array of signals, each with the following fields:

  • model: The name of the signal
  • score: The raw score value from the model (if applicable)
  • version: The version of the signal. It is possible to have more than one version of a given signal. This enables side-by-side validation of new versions as the signals are improved over time.
  • label: The classification label for the signal. E.g. for the Intent signal, the possible labels are “genuine,” “neutral,” “risky,” and “insufficient data.”

Signal Attributes

The lower-level data elements utilized to arrive at the classification for a signal. For customers who have purchased ID Attributes, a block of associated attributes is added to each element in the Signals Array under the heading of “attributes.” The keys of this map is a string, while the values could be different data types.

Path Params
string
required
Defaults to my-id

Required: The ID you wish to retreive signals and/or attributes for (likely set via SET_USER_ID)

string
required
Defaults to form_mysite

Required: The ID of your site or form being protected

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json