Identity Resolution API

The Identity Resolution API enables you to deanonymize website visitors and resolve them as prospects and customers in ZI Chat. It can be enabled by including a line of JavaScript code to pages where a chat widget is not required, for example, pages where customers log into your platform or FAQ pages.

Adding the Identity Resolution script allows visitor information such as email id, visitor type, or other visitor identifiers to be pushed to ZI Chat through the  setVisitor method, which requires minimal development effort.

It allows visitor information to be pushed as an object to ZI Chat. This enables ZI Chat to serve as your Identity store to help you distinguish between your prospects and customers. This way, you can continue to focus on marketing efforts on your website despite high website or page traffic.

How can the Identity Resolution API empower your Marketing efforts?

• It helps you identify and distinguish between prospects and customers on your website at an individual visitor level.
• Push visitor identity information to the ZI Chat layer through the Identity Resolution API. You can use data captured by ZI Chat in pages with the Identity Resolution script to personalize visitor experiences across other pages on your website or through the ZI Chat widget.
• Push customer or visitor status to ZI Chat fields and resolve your visitors in the ZI Chat visitor profile.
• Visualize and distinguish between prospects and customers in the ZI Chat Analytics tab through Tag-based filters.

Note: If the insentIdentityWidget is false or undefined, then the full ZI Chat widget will load on the webpages where the ZI Chat JavaScript is set up.

The insentIdentityWidget flag should be enabled so that all the widget scripts and iframe are not loaded:

insentIdentityWidget = true; //optional parameter to load a minimized version of ZI Chat without the Chat Widget

Enable insentIdentityWidget parameter

<script>
    //insentLoadLazy = true; //optional parameter to hide widget until setVisitor is called.  
    insentIdentityWidget = true; //optional parameter to load a minimized version of ZI Chat without the Chat Widget
    insentCompanyDomain = 'company.com'; 
    insentProjectName = 'yourcompanyname'
    insentProjectKey = 'Samplekey' 
    var t = window.insent || {}; t.queue = []; 
    (t.SCRIPT_VERSION = '0.1.2'),
    (t.methods = ['widget', 'listener', 'setVisitor']), 
    (t.factory = function (e) { return function () { 
      var n = Array.prototype.slice.call(arguments); return n.unshift(e), t.queue.push(n), t; }; 
    }), 
    t.methods.forEach(function (e) { t[e] = t.factory(e); }); insent = t; 
    var s = document.createElement('script'); 
    (s.type = 'text/javascript'), (s.charset = 'utf-8'), (s.defer = !0), 
    (s.src = 'https://yourcompanyname.widget.insent.ai/insent'), 
    window.addEventListener('load', function (n) { 
      document.body.appendChild(s); 
    });
  </script>

If you have not set up the ZI Chat JavaScript on your website, please refer to this article on how you can include the ZI Chat JS to pages on your website.

Note: The Identity Resolution API can be used to personalize and deanonymize traffic across only the same web domain.

Setup - Push visitor data to ZI Chat

To push visitor data to ZI Chat, you can use the ZI Chat  =setVisitor method. You can follow the script below or refer to the ZI Chat API documentation to learn more. 

You can push values to any ZI Chat fields or ZI Chat custom fields. You can create a custom field on the field mapping page, and these fields can be pushed to your connected CRM and MAP systems by enabling the 'Overwrite' settings for field mapping. Learn more about creating and mapping fields in the field mapping page.

Sample Script to push visitor data to ZI Chat

<script>
  window.insent.setVisitor(
    { 
      email: email.value,
      firstName: firstName.value,
      lastName: lastName.value,
      visitorType: visitorType.value,
    }
  );
</script>

How is the visitor identified once the setup is complete?

When a visitor lands on the page with an active ZI Chat JavaScript with the Identity Resolution flag enabled, the visitor’s cookie will be mapped with the visitor email sent through the  setVisitor method. This helps ZI Chat resolve the visitor’s identity through a combination of email and cookie resolution.

Additional details can be passed through the  setVisitor method to help further segment the visitor and identify whether they belong to the ideal customer persona.

Please feel free to reach out to our Customer Success team on success@insent.ai or chat with us through the chat widget on our knowledge base, in case you would like to learn more!