Properties

Here is a compilation of properties that empower you to customize the Axitech Widget's functionality. These properties afford you the flexibility to fine-tune the user experience according to your specific requirements.

Note: properties marked with * are also used in the standalone version of the widget

Property Details

type Property

This property allows you to specify the type of claim you want to create. By setting this property, you can preselect a default claim type for the user.

clientID Property

This property requires your unique client ID, which serves for authentication and tracking purposes. The client ID is used to identify and associate claims with your application.

contact Object

This object contains contact information that will be displayed in the "Contact Us" section of the app's widget. The contact details provide users with a way to reach out for assistance and support during the claim creation process.

• phone (string, required): The contact phone number that users can use to call for support.
• email (string, required): The contact email address that users can use to email for support.

policy Object

This object contains insurance-related information that can be associated with the claim. It helps in identifying the insurance provider and policy associated with the claim.

• provider (string, optional): The name of the insurance provider.
• number (string, optional): The policy number associated with the claim.
• validTo (string, optional): The date when the policy expires.
• validFrom (string, optional): The date when the policy becomes valid.

  holder Object (optional)

  
  This object represents the user who is initiating the claim creation process. It includes various user-related information that can be useful for tracking and communication purposes.
  • phone (string, optional): The user's phone number.
  • email (string, optional): The user's email address.
  • firstName (string, optional): The user's first name.
  • lastName (string, optional): The user's last name.
  • any other user-related information
  
  

  vehicle Object (optional)

  
  This object contains details about the vehicle associated with the claim, such as the license plate number.
  • licensePlate (string, optional): The license plate of the vehicle associated to this policy and involved in the claim.
  • any other vehicle-related information
  
  

  linkedContacts Array (optional)

  
  This array contains contact information for other individuals associated with the policy. Each entry in the array conforms to the holder object.

currentUserId Property

This property allows you to specify the user's unique ID for session tracking. This ID is used to identify and associate claims with the user. It is required when sessionTracking is on.

initialStepKey Property

This property allows you to specify the initial step for the claim creation process. Users will start at this step when they begin creating a claim. The value for this property must be chosen from the following list of valid steps:

• 'accident-selector'
• 'single-vehicle-form'
• 'multiple-vehicle-form'
• 'windscreen-form'
• 'theft-claim-selector'
• 'vehicle-theft-form'
• 'theft-from-vehicle-form'
• 'other-claim-selector'
• 'malicious-damage-form'
• 'fire-damage-form'
• 'weather-damage-selector'
• 'flood-form'
• 'hail-lightning-form'
• 'other-weather-damage-form'
• 'locked-out-form'

sessionTracking Property

The sessionTracking property, when set to true, enables session tracking within the widget. This feature allows the widget to save a user's progress and reload previously entered field values when they return to the widget, ensuring a seamless and user-friendly experience. Set this property to false if you do not wish to enable session tracking.

Enabling session tracking can be particularly useful for improving the user experience and reducing the need for users to re-enter information when interacting with the widget across multiple sessions.

state Property

The state property allows you to define the current state of the widget, providing detailed information related to the ongoing claim process. This property is an object with various sub-properties that offer a comprehensive view of the claim's status. Let's explore each sub-property:

• date (string, optional): The date associated with the claim.
• location (address, optional): An object describing the location or address related to the claim. It includes properties such as latitude, longitude, formatted address, address lines, city, state, country, and postal code.
• vehicleRoadWorthy (boolean, optional): Indicates whether the vehicle involved in the claim is roadworthy.
• driver (boolean, optional): Indicates the presence of a driver in the claim.
• injured (boolean, optional): Indicates if there are reported injuries associated with the claim.
• thirdParties (array of contact or thirdPartyDriver, optional): An array containing contact information for third parties involved in the claim. Each entry in the array conforms to the Contact or third party driver object.
• witnesses (array of contact, optional): An array containing contact information for witnesses present during the claim. Each entry follows the Contact object.
• reportedToPolice (boolean, optional): Indicates whether the claim has been reported to the police.
• dashCamFootageAvailable (boolean, optional): Indicates if dashcam footage is available for the claim.
• notificationTime (notificationTime, optional): Information about the preferred notification time, including values like 'anytime,' 'morning,' 'afternoon,' and 'evening.'
• termsAccepted (boolean, optional): Indicates if the terms and conditions have been accepted by the user.
• policy (policy, optional): An object representing policy information for the claim.
• vehicleImages (array of strings, optional): An array of URLs representing images of the vehicle associated with the claim.
• additionalImages (array of strings, optional): An array of URLs representing additional images related to the claim.
• note (string, optional): Additional notes or comments related to the claim.
• stepKey (initialStepKey, required): Specifies the current step in the claim creation process. The StepKey is selected from a predefined list of options, including 'accident-selector,' 'single-vehicle-form,' 'multiple-vehicle-form,' and more.
  

  address Object

  
  The Address object defines the structure of an address object, which can be used to represent location-related information associated with a claim. The Address object includes the following properties:
  • latitude (number, required): The latitude coordinate of the address.
  • longitude (number, required): The longitude coordinate of the address.
  • formattedAddress (string, optional): A formatted representation of the address.
  • addressLine1 (string, optional): The first line of the address.
  • addressLine2 (string, optional): The second line of the address.
  • city (string, optional): The city or locality of the address.
  • state (string, optional): The state or region of the address.
  • country (string, optional): The country of the address.
  • postalCode (string, optional): The postal or ZIP code of the address.
  
  

  contact object

  
  The Contact object defines the structure of contact information, which can be used to represent individuals involved in a claim. The Contact object includes the following properties:
  • firstName (string, optional): The first name of the contact.
  • lastName (string, optional): The last name of the contact.
  • email (string, optional): The email address of the contact.
  • type (string, required): Specifies the type of contact, which can be one of the following: 'driver,' 'motorcyclist,' 'pedestrian,' 'cyclist,' 'other,' or 'witness.'
  • phone (phone, optional): An object representing the phone number of the contact.
  • address (address, optional): An object representing the address of the contact.
  
  

  thirdPartyDriver object

  
  The ThirdPartyDriver object extends the Contact object and adds specific information related to a third-party driver involved in a claim. It includes all properties defined in the Contact object and additional properties:
  • vehicle (vehicle, optional): An object representing vehicle information for the third-party driver.
  • insurance (insurance, optional): An object representing insurance information for the third-party driver.
  
  The ThirdPartyDriver object is used when capturing details about a third-party driver, including their vehicle and insurance information.
  

  notificationTime object

  
  The NotificationTime object specifies the available options for preferred notification times related to a claim. It includes the following values:
  • anytime: Notifications can be received at any time.
  • morning: Notifications are preferred in the morning.
  • afternoon: Notifications are preferred in the afternoon.
  • evening: Notifications are preferred in the evening.
  
  

Please Note: If sessionTracking is set to true, the state property will be ignored.

The state property offers a comprehensive way to manage and track the progress of a claim within the widget. It allows you to store and retrieve various claim-related information, ensuring a smooth and organized claim creation process.

privacyPolicyUrl Property

This property allows you to specify the URL where the privacy policy associated with the claims creation process can be found. Providing a valid privacy policy URL ensures transparency and compliance with legal requirements regarding user data and privacy.

theme Object (Not Recommended)

The theme object allows you to customize the visual appearance of the app's widget. You can modify various visual aspects using color codes and font URLs.

• primary (string, optional): The primary color used for UI elements.
• secondary (string, optional): The secondary color used for UI elements.
• positive (string, optional): The color for positive actions.
• negative (string, optional): The color for negative actions.
• fontPrimary (string, optional): The font color used for primary text.
• fontSecondary (string, optional): The font color used for secondary text.
• background (string, optional): The background color of the widget.
• backgroundSoft (string, optional): A softer background color for certain UI elements.
• borderRadius (string, optional): The border radius for components in the widget.
• shadow (string, optional): Shadow effect applied to components.
• primaryBoldUrl (string, optional): URL for a bold primary font.
• primaryRegularUrl (string, optional): URL for a regular primary font.
• secondaryBoldUrl (string, optional): URL for a bold secondary font.
• secondaryRegularUrl (string, optional): URL for a regular secondary font.

Please Note: While you have the flexibility to configure the widget's visual appearance through theme-related properties, we highly recommend utilizing our admin interface for theming. The admin interface offers a user-friendly way to configure and manage the widget's theme, providing a more streamlined and efficient process for achieving the desired look and feel of the widget.

fontFamily Property (Not Recommended)

This property allows you to specify a custom font family to be used throughout the widget. You can set it to any valid font family name.

Please Note: While you have the flexibility to configure the widget's font family, we highly recommend utilizing our admin interface for this. The admin interface offers a user-friendly way to configure and manage the widget's fonts.