POST /signal/prepare
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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
client_id |
String | No |
Your Plaid API |
access_token |
String | Yes |
The access token associated with the Item data is being requested for. |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.