plaid

Send a new event to enrich user data

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

post/protect/event/send

Request

Base URL
https://production.plaid.com
URL
https://production.plaid.com/protect/event/send
Auth
API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

client_idstring

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.

secretstring

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.

timestampstring date-time

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"

device_session_idstring

Device Session ID should be provided for any event correlated with a frontend user session started via the Protect SDK.

request_trust_indexboolean

Whether this event should be scored with Trust Index. The default is false.

event_idstring required

The id of the recorded event.

fraud_attributesFraudAttributes nullable

Event fraud attributes as an arbitrary set of key-value pairs. The set of attributes returned varies by model.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.