Profiles Endpoint

GET https://api.neuro-id.com/v4.1/sites/{site_id}/profiles/{identity_id}

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.

Product	Signals Array	Signal Attributes	Interaction Attributes
ID Crowd Alert	No API Access
ID Orchestrator	Yes	No	No
ID Attributes	Yes	Yes	Yes

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.
• label: The classification label for the signal. E.g., for the Intent signal, the possible labels are genuine, neutral, risky, and insufficient data.
• attributes: The lower-level data elements used to arrive at the classification for a signal. Only available for customers who have purchased ID Attributes. A block of associated attributes are added to each element in the signals array under the heading attributes. The keys of this map are strings, while the values could be different data types.

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.

API Best Practices

❗️

The signals array does not have a fixed length or order.

Do not assume the length or order is fixed.

The NeuroID API provides helpful information to assist with appropriately interpreting and processing the response. Carefully consider the following when evaluating the API response.

Check HTTP status code
│
├── If HTTP status code is not 200
│   └── Handle error. 
│       ├── Check 'response["status"]' and 'response["message"]'
│       │   for error details.
│       │
│       └── (End)
│    
├── If HTTP status code is 200
│   ├── Check 'response["status"]'
│   │   
│   ├── If 'response["status"]' is "SITE_NOT_CONFIGURED"
│   │   ├── Check 'response["message"]' for details.
│   │   │   Data has been received for this profile though the site still
│   │   │   needs to be configured to calculate an accurate result.
│   │   │
│   │   └── (End)
│   │
│   ├── If 'response["status"]' is "NOT_ENOUGH_INTERACTION_DATA" 
│   │   ├── Check 'response["message"]' for details.
│   │   │   Data has been received for this profile though the
│   │   │   signals have insufficient data to calculate a result.
│   │   │
│   │   └── (End)
│   │
│   ├── If 'response["status"]' is "SUCCESS"
│   │   ├── Iterate through 'response["profile"]["signals"]'
│   │   │   └── Check 'signal["model"]' for the model you need.
│   │   │
│   │   └── (End)
│   │
│   └── (End)
│
└── (End)

👍

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.