v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-313352,3122.9 MB
plaid

Opt-in an Item to Signal Transaction Scores

When an Item is not initialized with signal, call /signal/prepare to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where signal was added in the additional_consented_products array but not in the products, optional_products, or required_if_supported_products array. If /signal/prepare is skipped on an Item that is not initialized with signal, the initial call to /signal/evaluate on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score.

If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score.

If run on an Item that is already initialized with signal, this endpoint will return a 200 response and will not modify the Item.

post/signal/prepare

Request body

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.

access_tokenstring required

The access token associated with the Item for which data is being requested.

Response

OK

request_idstring required

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