Analytics API (v5)

Analytics API V5 is designed for customers who would like to retrieve results unified across multiple use cases in their application. This API will add additional value for customers using Account Defense (AD) in combination with Account Opening (AO) product sets.

Multiple Use Cases

NeuroID refers to different "experiences" or "flows" in your application as use-cases. In the API results the use case name is provided as useCaseName. For example, you may have a "sign-up", "login", and "account settings" use case in your application. The Analytics API v5 allows you to retrieve NeuroID's Behavioral, Device, and Network Intelligence signal across all of the use-cases that a user may interact with.

Multiple Platforms

use-cases can also extend across platforms. For example, you may have a "login" use case in web, iOS, or Android. A user may use different devices to "login" to your application, but the use-case is still "login".

Multiple NeuroID siteIds

In the same way that a single use-case can be associated with multiple platforms, a single use-case may be associated with more than one NeuroID data collection siteId. For example, user data collected when the user logs in on web will use a different NeuroID siteId than user data collected during login activities on iOS, but both of these siteIds will be associated with the "login" use-case.

Additional Configuration

A NeuroID Implementation Engineer (IE) must configure the v5 API for your use-cases. Each NeuroID data collection siteId used in your front-end data collection integration must be assigned a useCaseName and productType.

Examples

Example of a Multi Platform / Multi use case Application.

Example only: Your IE will provide a table like this for your integration.

siteId	Platform	Site Name (used in NeuroID portal)	useCaseName	productType
form_neuro110	Web	Signup Web	Signup	AO
form_neuro111	iOS	Signup iOS	Signup	AO
form_neuro112	Android	Signup Android	Signup	AO
form_neuro120	Web	Login Web	Login	AD - Login
form_neuro121	iOS	Login iOS	Login	AD - Login
form_neuro122	Android	Login Android	Login	AD - Login
form_neuro130	Web	Account Settings Web	Account Settings	AD - Post login
form_neuro131	iOS	Account Settings iOS	Account Settings	AD - Post login
form_neuro132	Android	Account Settings Android	Account Settings	AD - Post login

The API payload for a user who interacted with every use case in this example ("Sign-up", "Login", and "Account Settings" will be structured like the example JSON structure below. Note that interactionAttributes{} and signals{} will be populated with additional data.

API result

{
    "status": "SUCCESS",
    "message": "success",
    "moreInfo": null,
    "useCaseResults": [
        {
            "siteId": "form_neuro110",
            "funnel": "unknown",
            "clientId": "78cf8a82-89b8-4e59-b1b7-9b022d85404e",
            "useCaseName": "Sign-up",
            "registeredUserId": null,
            "productType": "AO",
            "interactionAttributes": {},
            "signals": {},
            "id": "User-1",
        },
        {
            "siteId": "form_neuro121",
            "funnel": "unknown",
            "clientId": "78cf8a82-89b8-4e59-b1b7-9b022d85404e",
            "useCaseName": "Login",
            "registeredUserId": null,
            "productType": "AD - Login",
            "interactionAttributes": {},
            "signals": {},
            "id": "User-1"
        },
        {
            "siteId": "form_neuro132",
            "funnel": "unknown",
            "clientId": "78cf8a82-89b8-4e59-b1b7-9b022d85404e",
            "useCaseName": "Account Settings",
            "registeredUserId": null,
            "productType": "AD - Post login",
            "interactionAttributes": {},
            "signals": {},
            "id": "User-1"
        }
}
          

NOTE: Regardless of which platform is used, there will only be one entry in the list for each configured use-case. The entry in the useCaseResults list will be the best representation of the intentions of the user.

If a use-case is not properly configured with the useCaseName and productType, it will not be available in the useCaseResults list.