Pass-Through Additional User Information

How to Pass Additional User Information in PAVE API

The PAVE API allows you to pass additional information about specific users in the JSON results for a session. This is useful when you want to combine information from different sources in a single session, for example, from a lead form on a website to the results payload sent to your CRM.

Separating Contact Name into First Name and Last Name

You can use the contact object within the session details to separate the contact name into two fields: first_name and last_name. If you are using the SMS method to send the capture link, you can keep the contact name separated into two fields instead of including the to_name in the sms object. The contact object is optional, but both fields are required if used.

Adding Additional User Information

You can add any additional user information in the reference object in the session details. PAVE will include any fields you provide within the reference object in your results payload and will delete it a few hours after the session completes.

IMPORTANT: Do not include any sensitive information such as credit card or social security numbers in these fields. PAVE requires you to use methods such as Cloud Data Loss Prevention (DLP) to de-identify sensitive data in text content. De-identification is the process of removing identifying information from data by masking, deleting, encrypting, or obscuring it.

Sample Request with Pass-Through Contact Information

Here is a sample request with pass-through contact information:

{
  "session": {
    "theme": "LITE",
    "redirect_url": "https://www.url-to-redirect-user-to.com",
    "language": "EN",
    "client_id": "SOUTH234889",
    "contact": {
      "first_name": "required",
      "last_name": "required"
    },
    "reference": {
      "any_key": "any_value"
    }
  }
}

Sample Result with Pass-Through Contact Information

Here is a sample result with pass-through contact information:

{
  "session_key": "TOA-IGOLDCIBY3",
  "theme": "LITE",
  "active": true,
  "status": "IDLE",
  "redirect_url": "https://paveinspect.com/",
  "inspect_started_at": null,
  "inspect_ended_at": null,
  "created_at": "2021-08-17T13:49:16+00:00",
  "updated_at": "2021-08-17T13:49:16+00:00",
  "language": "EN",
  "options": {
    "client_id": "DLVNQC",
    "contact": {
      "first_name": "Luan",
      "last_name": "tran"
    },
    "reference": {
      "coupon_code": "TST-PAVE-00001",
      "coupon_value": 200
    },
    "sms": {
      "to": "[phone]",
      "to_name": null,
      "from": "+849