Sample - Plaid API
POST/protect/event/sendDeprecated

Send a new event to enrich user data

Sends a new event to enrich user data and optionally calculates a Trust Index score. Supply the event object with its required timestamp, and set request_trust_index to request scoring. This operation is closing down and will be removed on a date not specified in the API definition.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

6 body fields

Request data for recording a Protect event and optionally calculating its Trust Index score.

client_idstringoptional
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.
secretstringoptional
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.
timestampstringoptional
Timestamp of the event. Might be the current moment or a time in the past. In [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format, e.g. `"2017-09-14T14:42:19.350Z"`
eventobjectrequired
Event data for Protect events.
device_session_idstringoptional
Device Session ID should be provided for any event correlated with a frontend user session started via the Protect SDK.
request_trust_indexbooleanoptional
Whether this event should be scored with Trust Index. The default is false.

1 status code
200Returns the recorded event identifier, an optional Trust Index result with score details, fraud attributes, and a request identifier.
event_idstringrequired
The id of the recorded event.
trust_indexobjectoptional
Represents a calculated Trust Index Score.
fraud_attributesobjectoptional
Event fraud attributes as an arbitrary set of key-value pairs. The set of attributes returned varies by model.
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Error handling

event is required and must include a timestamp in ISO 8601 date-time format. If provided, the top-level timestamp and device_session_id must use their documented event formats, and request_trust_index controls whether scoring is requested.