Add or update a metadata

This service allows you to add or update custom metadata to a user, such as driving indicators that have been calculated in your backend.

You can add as many metadata as you need in a key-value format.

Metadata can be synchronized in the mobile application and displayed to the user.

If you have your admin API key, you can try the API via this link.

Add or update metadata to a driver

Add or update metadata to a driver

put

/drivekit/admin/drivers/{userId}/metadata

Path parameters

userIdstringrequired

Header parameters

DriveKit-Admin-API-Keystringrequired

Drivekit Admin API key

Body

metaDataobjectrequired

Key/value pairs in String format

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://develop.drivequant.com/v3/drivekit/admin/drivers/{userId}/metadata' \
  --header 'DriveKit-Admin-API-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{"metaData":{"annualSafetyScore":"8.9","monthlyCustomScore":"9.8"}}'

200

400

401

404

200

{
  "metaData": {
    "annualSafetyScore": "8.9",
    "monthlyCustomScore": "9.8"
  }
}

OK

Use case: custom scores

Custom scores can be calculated over a specific period of time (policy year, calendar year, 12 months rolling period...) using the individual scores of the trips made during this period, or using timelines.

If a customer has calculated one (or more) custom score(s) for a driver, this service can be used to attach this metadata to the driver. These scores can then be displayed to the user in the mobile app, and can be linked to a reward or a discount on an insurance premium.

Scores can be added one at a time or, more effectively, all at once:

Adding one score

JSON body (request)

{
   "metaData" : {
     "annualSafetyScore" : "8.9"
   }
}

Adding several scores

JSON body (request)

{
   "metaData" : {
      "annualSafetyScore" : "8.9",
      "annualDistractionScore" : "9.8"
      "monthlyCustomScore": "8.1"
   }
}

Scores can also be updated using the same service, providing a new value for the same key. This can be used for the driver to have a regular update on his/her progress.

Example:

1. First, set the driver's score to 9.8: {"metaData":{"monthlyCustomScore": "9.8"}}

2. Then, set it to 8.7: {"metaData":{"monthlyCustomScore": "8.7"}}