Skip to main content

Fairmatic Insurance SDK Validation Guide

After you integrate the Fairmatic SDK, you’ll need to validate that the SDK is capturing trip and driver data correctly to ensure that the Fairmatic product is fully functional. Generate a validation report that you can use to fully validate your Fairmatic SDK integration.

Generating a Validation Report​

To get started, you should have a backend pipeline set up. This can be as simple as Google Firebase or any other backend database where you can save information from your application.

Using the structure given below, generate the report in a .CSV file format. You can check a sample of the input CSV file here

The report format is as follows:

Sample input file

  • The first column (String) should be titled driver_id and should refer to the unique alphanumeric Driver ID that you’ve assigned to each driver.
  • The second column (String; P1, P2, P3) should be titled period and should refer to the current Period that the driver is in with your application.
  • The third column (Integer) should be titled start_timestamp and should refer to the epoch timestamp at the moment that the driver interacted with the UI to change periods to start a new period.
  • The fourth column (Integer) should be titled end_timestamp and should refer to the epoch timestamp at the moment that the driver interacted with the UI to change periods to end the current period.
info

If there's a high delta between the UI interaction from the driver and the actual point in time the respective Fairmatic Insurance API is called, record the time instead at the point where the actual API is called.

Analyzing the Validation Report​

Validation Tool​

Once you’ve successfully generated the report, log in to our Validation Tool. The screen should look like this:

Validator tool

Upload the generated report using the "Upload File"

Validation Results​

After you submit your validation reports to the tool, you’ll receive results that look like this:

Validation report

The result contains the following fields:

Invalid Trips - **** These can be caused by the start timestamp being greater than or equal to the end timestamp, or other logistical reporting errors. Please ensure that the timestamps are correct and that there are only integers being reported in the timestamp columns.

Mismatching Periods - **** The reported period in the validation report does not match the period that was captured by the Fairmatic SDK.

Non-Overlapping Trips - The timestamp interval (start timestamp to end timestamp) does not overlap at all with Fairmatic’s recorded timestamp interval.

Partially Overlapping Trips - The timestamp interval (start timestamp to end timestamp) doesn’t meet the minimum threshold of overlap required to count the trip as a match.

Matched Trips - Trips that meet all the matching criteria and count as a match towards the overall match percentage.

You can also download the detailed validation report on this page.

SDK Integration Check-Off​

Once you’ve iterated over your Fairmatic SDK Integration, make sure that the final overall match percentage is in line with what your Solutions Engineer has told you is an acceptable match percentage. Once that’s the case, please send the final overall match percentage along with all validation results to your Solutions Engineer.