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.
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.