Get Protect user insights

POST /protect/user/insights/get

Use this endpoint to get basic information about a user as it relates to their fraud profile with Protect.

Request Body

Required

Request object for /protect/user/insights/get

Parameters

client_id
string
Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.
secret
string
Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.
user_id
string
The Plaid User ID. Either user_id or client_user_id must be provided.
client_user_id
string
A unique ID representing the end user. Either user_id or client_user_id must be provided.

Response

Response object for /protect/user/insights/get

Response Properties

user_id
required, string
The Plaid User ID. If a client_user_id was provided in the request instead of a user_id, a new user_id will be generated if one doesn’t already exist for that client_user_id.
latest_scored_event
required, object
The latest scored event for a user.
event_id
required, string
The event ID.
timestamp
required, string
The timestamp of the event, in ISO 8601 format, e.g. "2017-09-14T14:42:19.350Z"
event_type
string
The type of event.
trust_index
required, object
Represents a calculate Trust Index Score.
score
required, integer
The overall trust index score.
model
required, string
The versioned name of the Trust Index model used for scoring.
subscores
required, object
Contains sub-score metadata.
device_and_connection
object
Represents Trust Index Subscore.
score
required, integer
The subscore score.
bank_account_insights
object
Represents Trust Index Subscore.
score
required, integer
The subscore score.
fraud_attributes
required, object
Event fraud attributes as an arbitrary set of key-value pairs.
request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.