Sample - Plaid API
POST/protect/user/insights/get

Get Protect user insights

Retrieves fraud-profile information and recent risk reports for a user in Protect. Provide either user_id or client_user_id to identify the user whose latest scored event and reports to retrieve. When you provide only client_user_id, a Plaid User ID is generated if one does not already exist.

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

4 body fields

Request object identifying the user whose Protect insights to retrieve.

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.
user_idstringoptional
The Plaid User ID. Either `user_id` or `client_user_id` must be provided.
client_user_idstringoptional
A unique ID representing the end user. Either `user_id` or `client_user_id` must be provided.

1 status code
200Returns the Plaid User ID, the latest scored event when available, up to the 100 most recent Protect reports in reverse-chronological order, and a request identifier.
user_idstringrequired
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_eventobjectrequired
The latest scored event for a user.
reportsarray<object>optional
List of Protect reports associated with this user, limited to the most recent 100 reports in reverse chronological order (newest first).
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

Provide either user_id or client_user_id to identify the user, but do not provide both. client_user_id must be the non-personally identifying user identifier previously associated with the user.