Initialize Plaid Items
Create Plaid Items to be used with Signal Transaction Scores
Creating Plaid Items
Before getting a Signal Transaction Score for a proposed transaction, your end users need to link a bank account to your app using Link, Plaid's client-side widget. Link will connect the user's bank account and obtain the consent required to perform this evaluation.
See the Link documentation for more details on setting up a Plaid Link session. At a high level, the steps are:
Call
/link/token/create
.- Put
signal
in theproducts
array, along with the other Plaid products (except Balance) you will be requiring, e.g.products: [signal, auth]
. - Put any other Plaid products you plan to use in the
optional_products
orrequired_if_supported_products
arrays, e.g.required_if_supported_products: [identity]
.
- Put
Initialize Link using the
link_token
created in the previous step. For more details for your specific platform, see the Link documentation. The user will now go through the Link flow.Call
/item/public_token/exchange
to exchange thepublic_token
for anaccess_token
.Obtain the
account_id
of the account used for the transaction you wish to perform the evaluation on; this can be obtained from themetadata.accounts
field in theonSuccess
callback, or by calling/accounts/get
or/link/token/get
.
Once you have your Plaid Item, continue to evaluate the risk of the transaction.
Adding Signal to existing Items
You may have Items that were not initialized with signal
; for example, if you are adding Signal support to an existing Plaid integration. In this case, for best results, call /signal/prepare
on the Item before your first call to /signal/evaluate
. If you skip calling /signal/prepare
, the Item's first call to /signal/evaluate
will take longer and be less accurate, because Plaid will not have had the opportunity to pre-load certain data about the Item. Subsequent calls to /signal/evaluate
on the Item will have higher accuracy.
If you intend to add Signal to an existing Item and have enabled Data Transparency Messaging on the Item, you may need to send the Item through update mode. If you have a large number of existing Items that require update mode for this reason, contact your Plaid Account Manager for more details and assistance.