Telematics SDK | Developer portal
Telematics SDK | Developer portal
Service Desk
Data Hub
Talk to sales
Changelog
Get started
Product Wiki
PRODUCT DESCRIPTION
How it works
Scoring
Available data set
Reporting
External Articles
STEPS 1-3: Project Setup
Step 1: Account Registration
Step 2: Demo Applications
Step 3: Setup the DeviceToken farm
Step 4: SDK Installation
Get started
iOS SDK installation
Android SDK installation
Check SDK Installation
Changelog
Step 5: User Statistics & Analytics (API)
Platform - Statistics API
Platform - Telematics Data (tracks) API
SDK Features
Bluetooth Device - Get started
Trip Tags - Get started
PLATFORM FEATURES
User Management
Leaderboard
Vehicle Management
FNOL, Inspections & Damage Recognition
Get started
Profiles
Claims
Vehicle inspections
Photo processing
SNS
3rd party data processing
Heartbeats
Other
Response Codes
Resources
Archive
Report a bug
Data Hub
Talk to sales
Powered by GitBook

Claims

FNOL: Claims Management

Note: FNOL, Inspections and Damage Recognition services are closely integrated with Vehicle Management service. You have to create a vehicle first to register a claim.

get
Available accident types list

https://insp.telematicssdk.com/api/v1/accident_types
Authorization: Required with Token
Request
Response
Request
Headers
Authorization
required
string
Token. Get it via https://insp.telematicssdk.com/api/v1/profiles/login
Response
200: OK
{
  "Result": {
    "AccidentTypes": [
      {
        "Label": "string", // Accident type's human label
        "Key": "string" // Accident type's enum
      }
    ]
  }
}

post
Create a Claim

https://insp.telematicssdk.com/api/v1/claims
Authorization: Required with Token Content Type: application/json
Request
Response
Request
Headers
Authorization
required
string
Token. Get it via https://insp.telematicssdk.com/api/v1/profiles/login
Response
200: OK
{
  "Result": {
    "Claim": {
      "Id": 0,
      "Paint": "solid",
      "ClaimDateTime": "2020-10-20T14:50:13.153Z",
      "Description": "string",
      "Lat": "string",
      "Lng": "string",
      "DriverFirstName": "string",
      "DriverLastName": "string",
      "DriverPhone": "string",
      "DriverLicenseNo": "string",
      "InvolvedFirstName": "string",
      "InvolvedLastName": "string",
      "InvolvedLicenseNo": "string",
      "InvolvedVehicleLicenseplateno": "string",
      "VehicleMake": "string",
      "VehicleModel": "string",
      "VehicleLicenseplateno": "string",
      "CarToken": "string",
      "CarTowing": true,
      "CarDrivable": true,
      "CreatedAt": "2020-10-20T14:50:13.153Z",
      "UpdatedAt": "2020-10-20T14:50:13.153Z",
      "DriverName": "string",
      "InvolvedComments": "string",
      "Locations": "string",
      "State": "draft",
      "CanEdit": true,
      "Screens": [],
      "Quotes": [],
      "DamageReports": []
    }
  }
}
Request Body
Request Body
{
  "Claim": {
    "AccidentType": "string", // Required. Find available values via /api/v1/accident_types
    "Paint": "solid", // Required. Available values : solid, metallic, pearl
    "ClaimDateTime": "2020-10-20T14:42:05.308Z",
    "Description": "string",
    "Lat": "string",
    "Lng": "string",
    "DriverFirstName": "string", // you can get it via https://docs.telematicssdk.com/platform-features/back-end-as-a-service/management
    "DriverLastName": "string", / you can get it via https://docs.telematicssdk.com/platform-features/back-end-as-a-service/management
    "DriverPhone": "string", // you can get it via https://docs.telematicssdk.com/platform-features/back-end-as-a-service/management
    "DriverLicenseNo": "string",
    "InvolvedFirstName": "string", // Involved parties in the accident
    "InvolvedLastName": "string", // Involved parties in the accident
    "InvolvedLicenseNo": "string", // Involved parties in the accident
    "InvolvedVehicleLicenseplateno": "string", // Involved parties in the accident
    "VehicleMake": "string", // Required // https://docs.telematicssdk.com/platform-features/car-service/directories
    "VehicleModel": "string", // Required // https://docs.telematicssdk.com/platform-features/car-service/directories
    "CarToken": "string", // Required // https://docs.telematicssdk.com/platform-features/car-service/vehicles
    "VehicleLicenseplateno": "string"
  }

put
Update a Claim

https://insp.telematicssdk.com/api/v1/claims
Authorization: Required with Token Content-Type: application/json Important: You can update claim only if it's state is Draft, Pending or Processing.
Request
Response
Request
Headers
Authorization
required
string
Token. Get it via https://insp.telematicssdk.com/api/v1/profiles/login
Response
200: OK
{
  "Result": {
    "Claim": {
      "Id": 0,
      "Paint": "solid",
      "ClaimDateTime": "2020-10-20T14:50:13.153Z",
      "Description": "string",
      "Lat": "string",
      "Lng": "string",
      "DriverFirstName": "string",
      "DriverLastName": "string",
      "DriverPhone": "string",
      "DriverLicenseNo": "string",
      "InvolvedFirstName": "string",
      "InvolvedLastName": "string",
      "InvolvedLicenseNo": "string",
      "InvolvedVehicleLicenseplateno": "string",
      "VehicleMake": "string",
      "VehicleModel": "string",
      "VehicleLicenseplateno": "string",
      "CarToken": "string",
      "CarTowing": true,
      "CarDrivable": true,
      "CreatedAt": "2020-10-20T14:50:13.153Z",
      "UpdatedAt": "2020-10-20T14:50:13.153Z",
      "DriverName": "string",
      "InvolvedComments": "string",
      "Locations": "string",
      "State": "draft",
      "CanEdit": true,
      "Screens": [],
      "Quotes": [],
      "DamageReports": []
    }
  }
}
Request Body
Request Body
{
  "Claim": {
    "AccidentType": "string", // Required. Find available values via /api/v1/accident_types
    "Paint": "solid", // Required. Available values : solid, metallic, pearl
    "ClaimDateTime": "2020-10-20T14:42:05.308Z",
    "Description": "string",
    "Lat": "string",
    "Lng": "string",
    "DriverFirstName": "string", // you can get it via https://docs.telematicssdk.com/platform-features/back-end-as-a-service/management
    "DriverLastName": "string", / you can get it via https://docs.telematicssdk.com/platform-features/back-end-as-a-service/management
    "DriverPhone": "string", // you can get it via https://docs.telematicssdk.com/platform-features/back-end-as-a-service/management
    "DriverLicenseNo": "string",
    "InvolvedFirstName": "string", // Involved parties in the accident
    "InvolvedLastName": "string", // Involved parties in the accident
    "InvolvedLicenseNo": "string", // Involved parties in the accident
    "InvolvedVehicleLicenseplateno": "string", // Involved parties in the accident
    "VehicleMake": "string", // Required // https://docs.telematicssdk.com/platform-features/car-service/directories
    "VehicleModel": "string", // Required // https://docs.telematicssdk.com/platform-features/car-service/directories
    "VehicleLicenseplateno": "string"
  }

put
Update Claim's State

https://insp.telematicssdk.com/api/v1/claims/:id/change_state
Authorization: Required with Token Important! Follow the statuses workflow Content Type: application/json
Request
Response
Request
Path Parameters
ID
required
integer
Claim ID
Headers
Authorization
required
string
Token. Get it via https://insp.telematicssdk.com/api/v1/profiles/login/
Response
200: OK
{
  "Result": {
    "Claim": {
      "Id": 0,
      "Paint": "solid",
      "ClaimDateTime": "2020-10-20T14:50:13.153Z",
      "Description": "string",
      "Lat": "string",
      "Lng": "string",
      "DriverFirstName": "string",
      "DriverLastName": "string",
      "DriverPhone": "string",
      "DriverLicenseNo": "string",
      "InvolvedFirstName": "string",
      "InvolvedLastName": "string",
      "InvolvedLicenseNo": "string",
      "InvolvedVehicleLicenseplateno": "string",
      "VehicleMake": "string",
      "VehicleModel": "string",
      "VehicleLicenseplateno": "string",
      "CarToken": "string",
      "CarTowing": true,
      "CarDrivable": true,
      "CreatedAt": "2020-10-20T14:50:13.153Z",
      "UpdatedAt": "2020-10-20T14:50:13.153Z",
      "DriverName": "string",
      "InvolvedComments": "string",
      "Locations": "string",
      "State": "draft",
      "CanEdit": true,
      "Screens": [],
      "Quotes": [],
      "DamageReports": []
    }
  }
}
Body Request
Body Request
{
  "Claim": {
    "state": "string" // required see states's flow (https://docs.telematicssdk.com/platform-features/fnol-inspections-and-damage-recognition/how-it-works#statuses-workflow)
  }

get
Show a Claim

https://insp.telematicssdk.com/api/v1/claims/:id
Authorization: Required with Token
Request
Response
Request
Path Parameters
ID
required
integer
Claim ID
Headers
Authorization
required
string
Token. Get it via https://insp.telematicssdk.com/api/v1/profiles/login/
Response
200: OK
{
  "Result": {
    "Claim": {
      "Id": 0,
      "Paint": "solid",
      "ClaimDateTime": "2020-10-20T14:50:13.153Z",
      "Description": "string",
      "Lat": "string",
      "Lng": "string",
      "DriverFirstName": "string",
      "DriverLastName": "string",
      "DriverPhone": "string",
      "DriverLicenseNo": "string",
      "InvolvedFirstName": "string",
      "InvolvedLastName": "string",
      "InvolvedLicenseNo": "string",
      "InvolvedVehicleLicenseplateno": "string",
      "VehicleMake": "string",
      "VehicleModel": "string",
      "VehicleLicenseplateno": "string",
      "CarToken": "string",
      "CarTowing": true,
      "CarDrivable": true,
      "CreatedAt": "2020-10-20T14:50:13.153Z",
      "UpdatedAt": "2020-10-20T14:50:13.153Z",
      "DriverName": "string",
      "InvolvedComments": "string",
      "Locations": "string",
      "State": "draft",
      "CanEdit": true,
      "Screens": [],
      "Quotes": [],
      "DamageReports": []
    }
  }
}

get
Show user's Claims

https://insp.telematicssdk.com/api/v1/claims/
Authorization: Required with Token
Request
Response
Request
Headers
Authorization
required
string
Token. Get it via https://insp.telematicssdk.com/api/v/1/profiles/login/
Response
200: OK
{
  "Result": {
    "Claims": [
      {
        "Id": 0,
        "Paint": "solid",
        "ClaimDateTime": "2020-10-20T14:50:13.153Z",
        "Description": "string",
        "Lat": "string",
        "Lng": "string",
        "DriverFirstName": "string",
        "DriverLastName": "string",
        "DriverPhone": "string",
        "DriverLicenseNo": "string",
        "InvolvedFirstName": "string",
        "InvolvedLastName": "string",
        "InvolvedLicenseNo": "string",
        "InvolvedVehicleLicenseplateno": "string",
        "VehicleMake": "string",
        "VehicleModel": "string",
        "VehicleLicenseplateno": "string",
        "CarToken": "string",
        "CarTowing": true,
        "CarDrivable": true,
        "CreatedAt": "2020-10-20T14:50:13.153Z",
        "UpdatedAt": "2020-10-20T14:50:13.153Z",
        "DriverName": "string",
        "InvolvedComments": "string",
        "Locations": "string",
        "State": "draft",
        "CanEdit": true,
        "Screens": [],
        "Quotes": [],
        "DamageReports": []
      }
    ]
  }
}

delete
Delete a Claim

https://insp.telematicssdk.com/api/v1/claims/:id
Authorization: Required with Token
Request
Response
Request
Path Parameters
claim_id
required
string
​
Headers
Authorization
required
string
Token. Get it via https://insp.telematicssdk.com/api/v1/profiles/login
Response
200: OK
​
Previous
Profiles
Next
Vehicle inspections
Last updated 3 months ago
Contents
get
Available accident types list
post
Create a Claim
put
Update a Claim
put
Update Claim's State
get
Show a Claim
get
Show user's Claims
delete
Delete a Claim