uploadMockCollisions API Endpoint

The uploadMockCollisions API is used to test workflows involving the FNOL API and Webhook Notification. For example, the customer application can send this API to the Zendrive platform to trigger FNOL webhook notifications and to query other FNOL APIs.

This API will only work if customers have opted into the FNOL program.

API Details

POST URL: https://api.zendrive.com/v1/mock_collision

Headers

Name	Type	Description
Authorization*	String	APIKEY <APIKEY>
Content-Type*	String	application/json

Request Body

Name	Type	Description
	String

200: OK Mock collision accepted

{
    "msg": "Mock collision received"
}

400: Bad Request Missing mandatory parameters, or incorrect values

{
"error": "Bad Request with human readable message”
}

401: Unauthorized Wrong, or missing APIKEY Authorization Header

{
   "error": "Unauthorized request"
}

403: Forbidden FNOL is not enabled

{
    "msg": "Collision API is not supported."
}

Sample Request Body

{
    "driver_id": "sample_driver",
    "platform": "ios",
    "trip": {
        "start_timestamp": 1654507337123,
        "end_timestamp": 1654507337124,
        "start_latitude": 40.741895,
        "start_longitude": -73.989308,
        "end_latitude": 40.730872753789654,
        "end_longitude": -73.99384382499176,
        "distance_km": 1
    },
    "simple_path": [
        {
            "latitude": 40.741895,
            "longitude": -73.99384,
            "time_millis": 1654507534321
        }
    ],
    "events": [
        {
            "event_type": 3,
            "event_type_name": "OVERSPEEDING",
            "latitude_end": 40.741895,
            "longitude_end": 40.741895,
            "latitude_start": 40.741895,
            "longitude_start": 40.741895,
            "start_time_millis": 1654507534321,
            "end_time_millis": 1654507535321
        }
    ],
    "collision_information": {
        "timestamp": 1654507535321,
        "latitude": 40.741895,
        "longitude": 40.741895,
        "intermediate_confidence_number": 85,
        "final_confidence_number": 90,
        "current_speed_mps": 22,
        "g_force":  8.1,
        "heading_degrees":  79,
        "brake_distance_meters": 5.2,
        "airbag_deployed": true,
        "collision_severity":  "HIGH",
        "direction_of_impact": "REAR",
        "deceleration_rate_miles_per_hour_per_second": 1
    }
}

Response Fields

Field	Description
driver_id	The Id of the driver, specified when initializing Zendrive SDK in the mobile application.
platform	iOS or Android
trip	Information related to the trip.
trip_start_timestamp	Trip start timestamp in milliseconds, in UNIX epoch format.
trip_end_timestamp	Trip end timestamp in milliseconds, in UNIX epoch format.
trip_start_latitude	Trip start latitude
trip_start_longitude	Trip start longitude
trip_end_latitude	Trip end latitude
trip_end_longitude	Trip end longitude
distance_km [optional field]	The distance (in kilometers) covered in the trip.
simple_path [optional block]	Location trail for the trip
simple_path_latitude	Latitude of the point
simple_path_longitude	Longitude of the point
simple_path_time_millis	Timestamp of the point, in UNIX epoch format.
Events [optional block]	List of events in the tripScores API
collision_information	List of collision_information fields. Note: Among the collision_information fields, the following fields are optional, while the rest are mandatory: current_speed_mps g_force heading_degrees brake_distance_meters airbag_deployed collision_severity direction_of_impact deceleration_rate_miles_per_hour_per_second

The (driver_id, collision_timestamp) fields need to be unique for every request.