plaid

Compute Protect Trust Index scores and subscores

Changed on

Compute a Protect Trust Index score for a user. The model selected determines what is scored and what additional fields the response contains. For example, ti-link-session-3-<client> scores a completed Link session for fraud risk; cash-advance-ongoing-<client>-1.0 scores repayment risk for a cash advance, additionally populating per-amount-bucket subscores. Cash-advance models require that the user have a Plaid Item with Transactions enabled, or an Assets Report, before scoring.

The endpoint returns HTTP 400 with error_type = INVALID_REQUEST and error_code = FAILED_PRECONDITION when a required precondition is not met: for link-session models, when the Link session has not completed; for cash-advance models, when the user has not successfully linked any Item. For device-session models, the endpoint may return retryable error_code = SESSION_NOT_READY until the Protect SDK has delivered device data for the session.

post/protect/compute

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/protect/compute
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

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.

secretstring

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.

modelstring required

The name of the Trust Index model to use for scoring. Examples: ti-link-session-3 or ti-link-session-3.0 (link-session fraud), ti-identity-2.0 (identity fraud), and cash-advance-ongoing-<client>-1.0 (cash advances). Cash-advance models are client-scoped; use the model name issued for your client. The model specified may require certain fields within model_inputs; for example, ti-link-session-2 requires the link field. Cash-advance models do not use model_inputs.

Response

OK

scoreinteger nullable

The Trust Index score, on a 0-100 scale where higher values indicate lower risk.

modelstring

The versioned name of the Trust Index model used for scoring.

attributesFraudAttributes nullable

Event fraud attributes as an arbitrary set of key-value pairs. The set of attributes returned varies by model.

timestampstring date-time nullable

The timestamp when the Trust Index score and fraud attributes were computed, in ISO 8601 format, e.g. "2017-09-14T14:42:19.350Z"

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes