Get information about a user event

POST /protect/event/get

Get information about a user event including Trust Index score and fraud attributes.

Request Body

Required

Request object for /protect/event/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.
event_id
required, string
The event ID to retrieve information for.

Response

Response object for /protect/event/get

Response Properties

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"
trust_index
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
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.