The Profiles endpoint serves complete profile data for a user session. The Profiles endpoint response will vary depending on the NeuroID product(s) purchased. The table below outlines which blocks of data are returned for each NeuroID Product.
api_checkpoint_name
The api_checkpoint_name is a query parameter that is provided to distinguish distinct api calls. Since you may call the api at various points of a user application, the api_checkpoint_name will label different api calls. This query parameter is required. The value of this parameter should be a string, 5-100 characters, with underscores between words. It should identify the checkpoint at which the api is called. It may relate to a use-case but does not have to be a use-case as you might call the api multiple times per use-case. Some examples are:
account_opening_page_1account_opening_page_5login_successful_landing_pageaccount_settings_personal_details_page_1daily_analysis_batch_call
useCaseResults array
The useCaseResults array in the API response contains a list of useCaseResults specific to the ones that are configured for your application. Please see API v5 - Additional Configurationfor more information on configuration. This array is not fixed in length or order, and will change as additional use-cases are configured for your application. Additionally, this array will only contain use-cases that have been interacted with by that user.
Signals Dictionary
The signals block in the API response consists of an dictionary of signals, with the signal model name being the key.
model: The name of the signal.version: The version of the signallabel: The classification label for the signal. E.g., for the Intent signal, the possible labels aregenuine,neutral,risky, andinsufficient data.score: Numeric representation of the label classificationattributes: The lower-level data elements used to arrive at the classification for a signal. Not all signals will have attributes. If the signal does not have attributes, it will be an empty dictionary.reasonCodes: Specific to thefamiliaritymodel,reasonCodescorrespond to the decision matrix of an outcome.
Interaction Attributes
The interactionAttributes block in the API response contains 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. Only customers who have purchased ID Attributes will receive Interaction Attributes.
Try It!
To access the API, you must use a valid API Key available in the NeuroID Portal by navigating to Settings > API Keys.
The following Site Id and Identity Id combinations may be used with a valid API Key to retrieve test data from the API.
| Site Id | Identity Id | Description |
|---|---|---|
form_neuro100 | example-response-1 | Genuine |
form_neuro100 | example-response-2 | Risky |
form_neuro200 | example-response-4 | Neutral with Attributes |
form_neuro300 | example-response-1 | Genuine with Login Signals |
form_neuro300 | example-response-2 | Risky with Login Signals |
form_neuro400 | example-response-1 | Genuine with Device + Network Signals |
form_neuro400 | example-response-2 | Risky with Device + Network Signals |
form_neuro500 | example-response-1 | Genuine with Login and Device + Network Signals |
form_neuro500 | example-response-2 | Risky with Login and Device + Network Signals |
See our API Test Cases for more examples and detailed information.