POST /signal/prepare

When an Item is not initialized with Signal, call /signal/prepare to opt-in that Item to the Signal data collection process, developing a Signal 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 Signal will have access to less data for computing the Signal 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.

Request Body

Required

SignalPrepareRequest defines the request schema for /signal/prepare

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.

access_token

required, string

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

Response

SignalPrepareResponse defines the response schema for /signal/prepare

Response Properties

request_id