TruValidate (formerly known as iovation) Fraud Check

This document outlines the two-step process for accessing TruValidate Fraud Check result from the credolab Portal after successful client-side integration.

Get API key: To access TruValidate Fraud Check result from Credolab, you need to have the API key which is used to identify who tries to perform an action.
Request TruValidate Fraud Check: After logging in, you can request fraud check. This will initiate the processing of the data.

1. Obtain API key

The API key - is the key Credolab uses to identify the client who is accessing TruValidate Fraud Check result from the Credolab server.

How to get the API key:

the API key with the Requester role should be provided by Credolab right after the subscription is created.

2. Getting your TruValidate (formerly known as iovation) Fraud Check Result

The process of requesting a TruValidate Fraud Check from the credolab Portal is similar to the process of obtaining dataset insights.

POST /api/iovation/v1/{referenceNumber}/fraudchecks/{rulesetId}

This endpoint assesses the risk of transactions based on the provided device and transaction details. The result is only available if TruValidate scoring has been set up.

Request Headers

Header	Value	Description
`Authorization`	Bearer $API_KEY	The header is used to authorize the request. Remember that you will have to replace $API_KEY with your actual API key from Obtain API key.

Request Parameters

Name	Description
`referenceNumber [string]`	The unique identifier of the dataset for which the iovation score should be calculated
`rulesetId [string]`	The identifier for the rule set to use for the transaction. The value is NOT CASE-SENSITIVE

Request Body

Name	Description
`accountCode` `[string]`	`[required]`The unique identifier for the end user's account or for the transaction
`statedIp` `[string]`	`[optional]`End user's IP address
`transactionInsight`	`[optional]` Transaction attributes that can be optionally sent along with device information, that enable to be searched for fraud based on identity data.

Transaction Insight Parameters (optional)

Name	Description	Example
`email [string]`	Customer's email address.	`"[email protected]"`
`eventId [string]`	ID associated with a transaction. This may be your own system tracking IDs	`"168200gsd851"`
`mobilePhoneNumber [string]`	The user's mobile phone number.	`"+15032246010"`

Request Body Example (application/json)

{
  "statedIp": "string",
  "accountCode": "string",
  "transactionInsight": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  }
}

Response Result

The response result is the TruValidate fraud check result.

Main entity	Name	Description	Example
Result Attributes	`accountCode` `[string]`	The unique identifier for the end user's account or for the transaction	`"account_code"`
Result Attributes	`rulesetId` `[string]`	The identifier for the rule set to use for the transaction	`"ruleset_id"`
Result Attributes	`calculatedDate` `[timestamp]`	Date/time when the api is triggered by the requestor. Timestamp ISO 8601 format: yyyy-mm-ddThh:mm:ss.ffffff. Though it's expressed in Unspecified time zone, but treated and stored by credolab in UTC.	`"2020-12-16T02:26:50.046799"`
Result Attributes	`requester` `[string]`	E-mail login of the users who triggered the API.	`"[email protected]"`
Result Attributes	`data` `[entity]`	Fraud check result of the Blackbox analysis received from Iovation.com
Result Attributes	`statedIp` `[string]`	End user's IP address	`"127.0.0.1"`
Result Attributes	`transactionInsight` `[entity]`	Transaction attributes that were optionally sent along with device information, that enable to be searched for fraud based on identity data.