Annotate a crash

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 link.

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: CONFIRMEDAvailable options:

causestring · enumoptional

Cause of the accident

Default: UNKNOWNExample: VEHICLEAvailable options:

collisionAreastring · enum[]optional

Area of the vehicle that was involved in the collision

Default: ["UNKNOWN"]Example: ["FRONT","LEFT"]

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://service.drivequant.com/v3/drivekit/admin/crashes/{crashId}/annotations' \
  --header 'DriveKit-Admin-API-Key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "status": "CONFIRMED",
    "cause": "VEHICLE",
    "collisionArea": [
      "FRONT",
      "LEFT"
    ],
    "comment": "Claims received on 2025-02-13. Two cars involved in the crash, in a parking lot."
  }'

200

400

401

404

200

No Content

OK

---

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)