LogoLogo
ProductsUse casesDocsSupport
  • Introducing DriveKit
  • DriveKit Guides
  • Get started with drivekit
    • Trip recording lifecycle
    • iOS
      • 🚀Quick start
      • Advanced configurations
      • References
      • iOS DriveKit Demo App
    • Android
      • 🚀Quick start
      • Advanced configurations
      • References
      • Android DriveKit Demo App
      • Android 15 Migration guide
      • Android 14 Migration guide
      • Troubleshooting
  • Trip analysis
    • Introduction
    • iOS
      • Permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (iOS)
    • Android
      • Runtime permissions
      • Trip management
      • TripListener
      • Crash Detection
      • Beacon usage
      • Bluetooth usage
      • Custom metadata
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
      • Android
        • Get started
        • Working hours
        • Driver alert in case of crash
        • Trip recording widget
        • Location sharing
    • REST services
      • Trip
      • References
    • Trip Simulator
      • iOS
      • Android
  • PERMISSIONS UTILS
    • Introduction
    • User interface
      • iOS
        • Get started
        • Main configurations
      • Android
        • Get started
        • Main configurations
  • COMMON UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
    • References
  • DRIVER DATA
    • Introduction
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
      • Android
        • Get Started
        • Advanced configurations
        • Trips widgets
        • My Synthesis
        • My Driver Profile
  • Driver Data Timeline UI
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • Vehicle
    • Introduction
    • iOS
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (iOS)
    • Android
      • Get started
      • Vehicle management
      • Beacon management
      • Bluetooth device management
      • Odometer
      • References (Android)
    • User interface
      • iOS
        • Get started
        • Main configurations
        • Advanced configurations
      • Android
        • Get started
        • Main configurations
        • Advanced configurations
  • DRIVER ACHIEVEMENT
    • Introduction
    • iOS
      • Get started
    • Android
      • Get Started
    • User interface
      • iOS
      • Android
  • CHALLENGE
    • Introduction
    • Important challenge rules
    • iOS
      • Get started
      • References (iOS)
    • Android
      • Get started
      • References (Android)
    • User interface
      • iOS
        • Get started
      • Android
        • Get started
  • GROUP
    • Introduction
    • iOS
      • Get started
    • Android
      • Get started
  • React Native
    • Get started
    • Integration
  • Flutter
    • Get started
    • Integration
  • Push services
    • Introduction
    • Push Trip Data
    • Push Deleted trip
    • Push Crash Data
    • Push Diagnosis Data
  • ADMIN SERVICES
    • Beacon
      • Add
      • Replace
      • Delete
      • Configuration
    • Challenges
      • List of challenges
      • Challenge details
      • Registered users
      • Challenge ranking
      • Users' progress
      • Definitions
    • Customer
      • Activity timeline
    • Driver
      • Timeline
      • Synthesis
      • Identity
      • Status
      • Add or update a metadata
      • Vehicles
      • Profile
      • Application diagnoses
    • Drivers
      • Account
      • Statistics
      • Ranking
      • Expired accounts
    • Group
      • Timeline
      • Synthesis
    • Trips
      • Add or update a metadata
      • Delete a metadata
    • Vehicle
      • Create
      • Characteristics
      • Configuration
      • Statistics
      • Update mileage
      • Tire and brake wear update
      • References
  • Crashes
    • Annotate a crash
    • Revoke crash location URL
  • ENTERPRISE SERVICES
    • Introduction
    • Teams
      • Create a team
      • List of teams
      • Enable or disable a team
    • Hyper-admins
      • Create a hyper-admin
      • List of hyper-admins
      • Delete a hyper-admin
    • Monitoring
      • Get a push trip data report
      • Get a push crash data report
      • Request to retry failed trips
      • Request to retry failed crashes
      • Get the status of a task
  • Release notes
    • Changelog
      • iOS
      • Android
      • UI iOS
      • UI Android
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Crashes

Annotate a crash

PreviousCrashesNextRevoke crash location URL

Last updated 1 month ago

Was this helpful?

This service is used to annotate the crash data analysed by our prediction service. You can confirm or reject a crash and add key insights such as the cause of the crash, impact area, and additional comments.

Crash data certification using this annotation service is used to improve the accident prediction accuracy.

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


Request

The table below summarizes the elements included in the structure of the request body.

Field
Type
Description

status

string

Operator's evaluation of the status of the crash (required). Allowed values: CONFIRMED, REJECTED, UNKNOWN

cause

string

Cause of the accident (optional). Allowed values: VEHICLE, MOTORCYCLE, BICYCLE, PEDESTRIAN, ANIMAL, STATIC_OBJECT, ROAD_HAZARD, VEHICLE_CONTROL_LOSS, OTHER, UNKNOWN

collisionArea

array[string]

Area of the vehicle that was involved in the collision (optional). Allowed values: FRONT, REAR, LEFT, RIGHT, TOP, BOTTOM, UNKNOWN

comment

string

Free comment (max 500 characters, optional)

link
  • PUTAnnotate a crash
  • Request

Annotate a crash

put
Path parameters
crashIdstringRequired

Unique identifier of the crash

Header parameters
DriveKit-Admin-API-KeystringRequired

Drivekit Admin API key

Body
statusstring · enumRequired

Operator's evaluation of the status of the crash

Example: CONFIRMEDPossible values:
causestring · enumOptional

Cause of the accident

Default: UNKNOWNExample: VEHICLEPossible values:
commentstring · max: 500Optional

Free comment (max 500 characters)

Example: Claims received on 2025-02-13. Two cars involved in the crash, in a parking lot.
Responses
200
OK
400
Bad request
application/json
401
Unauthorized
404
Not found
application/json
put
PUT /v3/drivekit/admin/crashes/{crashId}/annotations HTTP/1.1
Host: service.drivequant.com
DriveKit-Admin-API-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "status": "CONFIRMED",
  "cause": "VEHICLE",
  "collisionArea": [
    "FRONT",
    "LEFT"
  ],
  "comment": "Claims received on 2025-02-13. Two cars involved in the crash, in a parking lot."
}

No content