Risk Signals Endpoint

get https://api.neuro-id.com/v6/sessions/{identity_id}/products/{product}

This document describes the NeuroID API v6. The API provides access to risk signals computed using behavior and device technology.

Common use cases are:

Retrieving data synchronously at login for a risk assessment on whether a login should proceed.
Retrieving data at a high risk transaction to determine whether the transaction should proceed.
Retrieving data after an account onboarding event indicating whether the application was suspicious.

The risk signals returned vary with the product accessed and the license purchased.

Notes:

For Account Defense, the ato_risk is a rolled up signal which summarizes the overall risk recommendation. The other signals are provided as extra information.

Test Cases:

To retrieve sample responses for different scenarios, you can add the example identity_id for the product feature you are interested in to the URL.
For example, for the Account Defense product, you can use the identity_id example_account_defense_signals_risky as follows. Other arguments are ignored.

  /v6/sessions/example_account_defense_signals_risky/products/account_defense

Open API Specification:
The Open API Specification is available at Open API Specification