Send a new event to enrich user data

POST /protect/event/send

Send a new event to enrich user data and optionally get a Trust Index score for the event.

Request Body

Required

Request object for /protect/event/send

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.
timestamp
string
Timestamp of the event. Might be the current moment or a time in the past. In ISO 8601 format, e.g. "2017-09-14T14:42:19.350Z"
event
required, object
Event data for Protect events.
timestamp
required, string
The timestamp of the event, in ISO 8601 format, e.g. "2017-09-14T14:42:19.350Z"
protect_session_id
string
If present, contains the current Protect Session ID from the Plaid Pixel SDK.
app_visit
object
This event type represents a user visiting the client application.
user_sign_in
object
This event type represents a user signing in to the application.
user_sign_up
object
This event type represents a user signing up for the application.
protect_session_id
string
Protect Session ID should be provided for any event correlated with a frontend user session started via the Protect SDK.
request_trust_index
boolean
Whether this event should be scored with Trust Index. The default is false.

Response

Response object for /protect/event/send

Response Properties

event_id
required, string
The id of the recorded event.
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.