createReview

Processes a JSON object containing user profile information and returns information about the reliability of that information.

IMPORTANT!  
This function requires:

Syntax

Copy 
function createReview(requestObject: any): any
 
Parameter Type Description
requestObject any JSON object containing user profile information.

The request object has the following structure:

Copy 
{
    "ref_id": "order-66", //unique identifier for the request
    "identities": [ //list of identities to be reviewed
    {
        "first_name": "John", //first name of the reviewed person
        "last_name": "Doe" //last name of the reviewed person
    }
    ],
    "email_addresses": [ //list of email addresses to be reviewed
        {
        "address": "john.doe@somecompany.com" // email address
        }, {
        "address": "john.doe@somecompany.com" // email address
        }
    ],
    "ip_addresses": [ //list of ip addresses to be reviewed
        {
        "address": "xxx.xxx.xxx.xxx" //ip address
        }
    ],
    "phone_numbers": [ //list of phone numbers to be reviewed
        {
        "number": "+33123456789" //phone number
        }
    ],
    "postal_addresses": [ //list of postal addresses to be reviewd
        {
        "type": 1, //type of the address. 1 - delivery address, 2 - billing address
        "route": "some street in Paris", //street name
        "city": "Paris",
        "state": "Ile-de-France",
        "postal_code": "xxxxx",
        "country_code": "FR"
        }
    ],
    "bin_numbers": [ //list of bank identification numbers to be reviewed
        {
        "number": 000000 // bank identification number
        }
    ]
}

Some limitations apply when analyzing a request object. Request objects can contain a maximum of:

Return Value

Returns an object containing information about the reliability of the user profile. The object has the following structure:

Copy 
{
    "id": "xxxx-xxxxx-xxxxx", //unique id identifying the request. To be used in getReview method
    "ref_id": "testid", //unique id from the requester side
    "created_by": { //details about the user that originally created the request
        "id": "xxxxxxxx-xxxx-xxxx", //unique id for the user
        "email": "test@test.com", //email of the user that created the request
        "first_name": "test", //first name
        "last_name": "account", //last name
        "roles": ["ROLE_USER" ] //list of roles the user has
    },
    "created_at": "2021-03-15T11:49:37+02:00", //date when request was created
    "reliability": 100, //percentage of reliability of the checked details
    "analyses": [ //list of performed analyses
        {
            "name": "email_o__email_pro",
            "label": "Email pro",
            "color": "#61AC91"
        },
        {
            "name": "email_o__email_active",
            "label": "Email is active",
            "color": "#61AC91"
        },
        {
            "name": "email_o__email_more_3yo",
            "label": "Email is more than 3 years old",
            "color": "#61AC91"
        },
        {
            "name": "phone_o__reachable",
            "label": "Phone number is reachable",
            "color": "#61AC91"
        },
        {
            "name": "phone_o__linked_to_account",
            "label": "Phone number linked to an account",
            "color": "#61AC91"
        },
        {
            "name": "last_name.phone_identity.level_1_match",
            "label": "level 1 consistency between the last name and one identity linked to one phone number",
            "color": "#61AC91"
        },
        {
            "name": "last_name.email_identity.level_1_match",
            "label": "level 1 consistency between the last name and one identity linked to the e-mail",
            "color": "#61AC91"
        },
        {
            "name": "last_name.email_username.level_1_match",
            "label": "level 1 consistency between the last name and the username in the e-mail",
            "color": "#61AC91"
        },
        {
            "name": "first_name.email_username.level_1_match",
            "label": "Level 1 consistency between the first name and the username in the e-mail",
            "color": "#61AC91"
        },
        {
            "name": "first_name.email_identity.level_1_match",
            "label": "Level 1 consistency between the first name and one identity linked to the e-mail",
            "color": "#61AC91"
        },
        {
            "name": "first_name.phone_identity.level_1_match", //The name of the analysis
            "label": "Level 1 consistency between the first name and one identity linked to one phone number", //The label / description of the analysis
            "color": "#61AC91" //The color code of the analysis.
        }
    ],
    "status": { //status of the review
        "key": "profile_or_order_can_be_validated", 
        "label": "Profile or order can be validated", //label explaining what the recomnded action is based on the request result
        "value": 2
    },
    "signals": { //list of signals. See description below
        "INT_000": 1,
        "INT_010001": 1,
        "EXT_010002": 1,
        "INT_010003": false,
        "EXT_010004": 1,
        "INT_010005": 1,
        "EXT_010006": 1,
        "INT_010007": false,
        "EXT_010008": 1,
        "INT_010010": false,
        "INT_010011": false,
        "INT_010012": false,
        "INT_010013": false,
        "INT_010014": false,
        "INT_010015": false,
        "INT_010016": false,
        "EXT_010017": false,
        "EXT_020001": "mobile",
        "INT_020002": false,
        "EXT_020003": 0,
        "EXT_020004": false,
        "EXT_020005": 0,
        "EXT_020006": true,
        "EXT_020007": false,
        "EXT_020008": 0,
        "EXT_020009": false,
        "EXT_020010": false,
        "EXT_020011": true,
        "EXT_020013_1": "2019-10-31",
        "EXT_020015": false,
        "INT_020031": true,
        "EXT_020032": false,
        "EXT_020033": false,
        "INT_020034": 0,
        "INT_020035": 1,
        "EXT_020037": false,
        "EXT_020040": false,
        "EXT_020041": false,
        "EXT_020042": true,
        "EXT_020043": true,
        "EXT_020044": true,
        "EXT_020045": false,
        "EXT_020046": false,
        "EXT_020047": false,
        "EXT_020048": 2,
        "EXT_020049": false,
        "EXT_020050": false,
        "EXT_020051": false,
        "EXT_020052": false,
        "EXT_020053": false,
        "EXT_020054": false,
        "EXT_020055": false,
        "EXT_020056": 0,
        "EXT_020058": 1,
        "EXT_020059": 0,
        "EXT_020060": 1,
        "EXT_020061": true,
        "EXT_020062": "41-50",
        "EXT_020063": true,
        "EXT_020064": true,
        "EXT_020065": false,
        "EXT_030001": 3,
        "EXT_030002": 1,
        "EXT_030003": 0,
        "EXT_030004": 0,
        "EXT_030005": 0,
        "EXT_030006": 2,
        "EXT_030007": 0,
        "EXT_030010": false,
        "EXT_030011": true,
        "EXT_030012": true,
        "EXT_030013": true,
        "EXT_030017": false,
        "INT_030020": false,
        "INT_030021": false,
        "EXT_030024": 1126,
        "EXT_030026": 0,
        "EXT_030027": false,
        "EXT_030028": false,
        "INT_030029": 0,
        "EXT_030031": 0,
        "EXT_030032": 0,
        "INT_030033": false,
        "INT_030034": 18,
        "INT_030035": 0,
        "INT_030036": 17,
        "EXT_030037": "2017-05-17",
        "EXT_030038": [
            "Professional Nw #1",
            "Social Nw #2"
        ],
        "EXT_030040": [],
        "INT_030043": 1,
        "INT_030044": null,
        "INT_030046": false,
        "INT_030047": false,
        "INT_030048": false,
        "INT_030050": 9,
        "EXT_030052": 0,
        "EXT_030053": 1,
        "EXT_030054": 0,
        "EXT_030055": 0,
        "EXT_030056": 0,
        "EXT_030057": 0,
        "EXT_030060": false,
        "EXT_030061": false,
        "INT_030065": false,
        "EXT_030067": 0,
        "EXT_040001": 0,
        "INT_040002": 1,
        "INT_040008": false,
        "INT_040009": false,
        "INT_040012": false,
        "INT_040013": false,
        "EXT_040014": false,
        "EXT_040015": true,
        "EXT_050006": false,
        "EXT_050007": false,
        "EXT_050008": false,
        "EXT_050009": "VISA",
        "EXT_050010": false,
        "EXT_060002": 2,
        "EXT_060003": false,
        "EXT_060006": false,
        "EXT_060007": false,
        "EXT_060008": false,
        "EXT_060009": false,
        "EXT_060010": false,
        "EXT_060011": false,
        "EXT_060012": false,
        "EXT_060018": 1,
        "EXT_060019": 1,
        "EXT_060021": false,
        "EXT_060022": false,
        "MIX_070001": {
            "email": [
                "FR"
            ],
            "phone": [
                "FR"
            ],
            "ip": [
                "FR"
            ],
            "postal_address": [
                "FR"
            ],
            "bin": [
                "FR"
            ]
        },
        "MIX_070002": true,
        "MIX_080001": {
            "ip_1": {
                "address_1": 4.4819297146791168
            },
            "address_1": {
                "ip_1": 4.4819297146791168
            }
        }
    },
    "enriched_data": {
        "enriched_emails": [],
        "enriched_phones": [],
        "enriched_ips": [],
        "enriched_bins": [],
        "enriched_addresses": [],
        "enriched_distances": {
            "meta": {
                "avg": 4.4819297146791168,
                "max": 4.4819297146791168,
                "min": 4.4819297146791168
            },
            "ip_1": {
                "address_1": 4.4819297146791168
            },
            "address_1": {
                "ip_1": 4.4819297146791168
            }
        }
    },
    "code": null,
    "message": null,
    "errors": null,
    "IsSuccess": true, 
    "ErrorMessage": null //containe the error message in case of error
}

Analyses

Analyses keys represent the set of validations that have been performed on the input data, with fields indicating the name, description, and color code of each analysis. You can use them to customize the Digital Review (Reliability) score if you have your own decision-making engine. For instance, you can apply modifiers based on some of your validations, such as, when you get a “Reliability” of 65, and a combination of labels “Phone number is ported” and “Level 1 consistency between the first name and one identity linked to one phone number”, you increase the “Reliability” score by 14. This would allow you to create your own “Reliability” score (65+14 = 79), within your own decision-making engine.

Status

Status of the review. A best practice is to automatically accept the input when the "value" field equals 2. This value relates to the "profile_or_order_can_be_validated" key and "Profile or order can be validated" label. The status fields can take the following values:

Signals

Signals are the inputs used for the creation of Analyses (i.e. “Rules”). They contain a technical code as a unique identifier, and a value associated to it. Signals are OneyTrust’s answer to GDPR compliance. Unlike analyses, signals are not self-explanatory. Their documentation is made available by OneyTrust by request, on a case-by-case basis. For more information, contact OneyTrust.