POST /protect/compute

Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes

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 `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.
`user`	Object	Yes	Represents an end user for /protect/compute requests.
`user.user_id`	String	No	The Plaid User ID returned from a previous call to `/user/create`. This or `client_user_id` can be provided, not both.
`user.client_user_id`	String	No	A unique ID representing the end user. Maximum of 128 characters. Typically this will be a user ID number from your application. Personally identifiable information, such as an email address or phone number, should not be used in the `client_user_id`.
`model`	String	Yes	The name of the Trust Index model to use for calculating the Trust Index Score, with an optional version suffix. Examples include `ti-link-session-2.0`, `ti-identity-2.0`, `ti-link-session`, and `ti-identity`. If the version suffix is not included, the most recent version of that model will be used. The model specified may require certain fields within `model_inputs`. For example, `ti-link-session-2.0` requires the `link` field to be provided in `model_inputs`.
`secret`	String	No	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.
`model_inputs`	Object	No	Inputs for the Trust Index model. The `link` field is required for any link session model type.
`model_inputs.link`	Object	No	Inputs for link session Trust Index models.
`model_inputs.link.require_extracted_data`	Boolean	No	Whether to wait for data to be extracted before computing and returning a score. If set to `true` and `/protect/compute` is called before data has been extracted, an error will be returned indicating that data has not yet been extracted. If set to `false`, a score will be computed and returned regardless of whether data has been extracted. If `false` and data has been extracted, extracted data will still be included in the score computation. Defaults to `false`.
`model_inputs.link.link_session_id`	String	Yes	A unique identifier for the Link session, used to compute a Trust Index score and fraud attributes.

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.