Supplemental Authentication Services

For clients that implement their own authentication, there are supplemental authentication services to help auto-fill information when onboarding customers and identifying whether they have worked with an agent before or not.

The fields service is designed to accept the agent's portal name and return what attributes the agent's require to be filled in. This can also take an optional contact ID and provide auto-fill information in the options hash related to the forms. It also will indicate the type of input required by the browser (text, phone, tel, etc.)

Consumer Authentication Fields

URI: /ticket/fields

HTTP Method Description Conditional Notes
GET Provides the signup and signup form requirements, which form to show, and pre-fill information based on identity. No
POST Returns HTTP 405 (Method Not Allowed) No Not implemented
PUT Returns HTTP 405 (Method Not Allowed) No Not implemented
DELETE Returns HTTP 405 (Method Not Allowed) No Not implemented

GET Request

Parameters:
Parameter Required Notes
portal_slug Yes Name of Agent's Portal.
contact_id No If known, can be passed in to pre-fill any known values about the contact.

GET Response

{
  "D": {
    "Success": true,
    "Results": [{
      "default": "sign_up",
      "sign_up": [{
          "name": "username",
          "type": "email",
          "required": true,
          "options": {
            "value": "teddy_wong@mailinator.com"
          }
        }, {
          "name": "new_password",
          "type": "password",
          "required": true,
          "options": {}
        }, {
          "name": "confirm_password",
          "type": "password",
          "required": true,
          "options": {}
        }, {
          "name": "first_name",
          "type": "text",
          "required": true,
          "options": {
            "value": "Teddy"
          }
        }, {
          "name": "last_name",
          "type": "text",
          "required": true,
          "options": {
            "value": "Wong"
          }
        }, {
          "name": "phone",
          "type": "tel",
          "required": true,
          "options": {
            "value": "867-5309"
          }
        }, {
          "name": "city",
          "type": "text",
          "required": true,
          "options": {
            "value": "Hollywood"
          }
        }, {
          "name": "region",
          "type": "text",
          "required": true,
          "options": {
            "value": "CA"
          }
        }, {
          "name": "zip",
          "type": "text",
          "required": true,
          "options": {
            "value": "98201"
          }
        }, {
          "name": "street",
          "type": "text",
          "required": true,
          "options": {
            "value": "123 Super Fast Ct."
          }
        }],
      "sign_in": [{
          "name": "username",
          "type": "email",
          "required": true,
          "options": {
            "value": "teddy_wong@mailinator.com"
          }
        }, {
          "name": "password",
          "type": "password",
          "required": true,
          "options": {}
        }]
    }]
  }
}

Consumer Authentication Fields Description

Attribute Data Type Description
default Character Provides default form to be shown if signup and login not shown at same time.
sign_up Character Provides HTML attributes and autofill options for the sign-up form.
sign_in Character Provides HTML attributes and autofill options for the sign-up form.

Sign-Up Form Description

Attribute Data Type Description
username Character Consumers email login. Uses 'email' HTML element attribute.
password Character Consumer login password. Uses 'password' HTML element attribute.

Sign-In Form Description

Attribute Data Type Description
username Character Consumers email login. Options hash may contain value to pre-fill consumer information with. Uses 'email' HTML element attribute.
new_password Character Consumer login password. Uses 'password' HTML element attribute.
confirm_password Character Consumer login password. Uses 'password' HTML element attribute.
first_name Character Consumer's desired first name. Options hash may contain value to pre-fill consumer information with.
last_name Character Consumer's desired last name. Options hash may contain value to pre-fill consumer information with.
phone Character Consumer's desired phone number. Options hash may contain value to pre-fill consumer information with. Uses 'tel' HTML element attribute.
city Character Consumer's desired city. Options hash may contain value to pre-fill consumer information with.
region Character Consumer's desired state. Options hash may contain value to pre-fill consumer information with.
zip Character Consumer's desired zip code. Options hash may contain value to pre-fill consumer information with.
street Character Consumer's desired street address. Options hash may contain value to pre-fill consumer information with.