mayer API (v1)

Download OpenAPI specification:Download

[COMMON] Filters

Retrieves list of filters

Responses

Response samples

200

Content type

application/json

{"states": [{"label": "Alabama",
"value": 1
},
{"label": "Alaska",
"value": 2
},
{"label": "Arizona",
"value": 3
}
],
"claim_statuses": [{"label": "To accept",
"value": "pending"
},
{"label": "Gathering information",
"value": "gathering_information"
},
{"label": "Information analysis",
"value": "information_analysis"
},
{"label": "Settlement activities",
"value": "settlement_activities"
},
{"label": "Settlement negotiations",
"value": "settlement_negotiations"
},
{"label": "Closing activities",
"value": "closing_activities"
},
{"label": "Finished",
"value": "finished"
},
{"label": "Closed",
"value": "closed"
}
],
"file_requirements": {"allowed_extensions": [".heic",
".jpeg",
".jpg",
".png",
".svg",
".avi",
".hevc",
".mov",
".mp4",
".mpeg4",
".wmv"
],
"file_size": 524288000
}
}

[COMMON] User/Admin profiles

Show user/admin profile

Authorizations:

Bearer Token

Responses

Response samples

200

Content type

application/json

Example

when current_user is user

{"id": 1,
"email": "eddy@sanford-kuhic.test",
"first_name": "Leena",
"last_name": "Stamm",
"phone_number": "6980139552",
"user_role": "fleet_driver",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:45.446Z",
"identifier": "76fd6c151c0acf5f1677e90ab4a29bb8ccd3350b0319b6b3a62bdc961a6174e9",
"company": {"id": 1,
"company_type": "fleet",
"email": "marcos_vandervort@reichel.example",
"name": "Ula Herman",
"onboarded": false,
"confirmed_at": null,
"phone_number": "6144939808",
"address": {"id": 1,
"full_address": "Apt. 391 83597 Walker Groves, Margrettbury, ID 71072",
"latitude": 76.03,
"longitude": 42.08,
"state": {"id": 4,
"full_name": "Tama Heidenreich I",
"short_name": "Shalonda Sporer"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
}

Update user/admin profile

Authorizations:

Bearer Token

Request Body schema: application/json

first_name	string
last_name	string
phone_number	string

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"phone_number": "string"
}

Response samples

200
422

Content type

application/json

Example

when current_user is user

{"id": 2,
"email": "shawn@weimann.test",
"first_name": "New First Name",
"last_name": "New Last Name",
"phone_number": "2515958987",
"user_role": "fleet_driver",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:45.680Z",
"identifier": "b092f5e71a43338a55ae18c8294dea0f5f658412cdbd0f1bd69eac74b326d67a",
"company": {"id": 2,
"company_type": "fleet",
"email": "missy.torphy@ruecker.example",
"name": "Mae Maggio",
"onboarded": true,
"confirmed_at": null,
"phone_number": "6561408135",
"address": {"id": 2,
"full_address": "464 Hettinger Fall, North Tamela, UT 22918-7801",
"latitude": 31.03,
"longitude": 30.77,
"state": {"id": 5,
"full_name": "Shaunna MacGyver",
"short_name": "Olive McKenzie"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
}

[COMMON] Access tokens

Get access token

Request Body schema: application/json

refresh_token	string
email	string
password	string min. 8 characters, min. one capital letter, min. one digit, min. one special character
scope required	string Value: "admin, user"
grant_type required	string

Responses

Request samples

Payload

Content type

application/json

Example

Obtain access token as user

{"email": "john.doe@example.com",
"password": "password",
"scope": "user",
"grant_type": "password"
}

Response samples

200
400

Content type

application/json

Example

when new access token is obtained as user

{"access_token": "sc5cvwJL1BFI83swqa2vfTrSnA9NrWptlobxofBArJs",
"token_type": "Bearer",
"expires_in": 7200,
"refresh_token": "T9MuhUsd7hka0pIeKhNCBtS90Q_agaacchd6LJ9CU_I",
"scope": "user",
"created_at": 1739885805,
"user": {"id": 6,
"email": "deandra@treutel.test",
"first_name": "Mindy",
"last_name": "Bergstrom",
"phone_number": "1893209013",
"user_role": "fleet_driver",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:45.811Z",
"identifier": "3f06f94d1422e06bafb97d0c2deac7820f56cca41df7aded227907ba429305ae",
"company": {"id": 6,
"company_type": "fleet",
"email": "hal@yost.example",
"name": "Msgr. Raeann Hansen",
"onboarded": true,
"confirmed_at": null,
"phone_number": "4484379822",
"address": {"id": 6,
"full_address": "Suite 410 2217 Sawayn Turnpike, Port Awilda, CO 72118-5661",
"latitude": 97.54,
"longitude": 16.39,
"state": {"id": 9,
"full_name": "Judie Nolan",
"short_name": "Rep. Antone Toy"
}
},
"states": [{"id": 10,
"full_name": "one",
"short_name": "1"
},
{"id": 11,
"full_name": "two",
"short_name": "2"
}
],
"active_claims_number": 0
},
"active_claims_number": null
}
}

Revoke access token

Request Body schema: application/json

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "RMFTakb-8kWVknGmqAHsmvWrY_aUXpBc4N2-GdHOC6I"
}

Response samples

200

Content type

application/json

{ }

[COMMON] Users

Request password reset for user

Request Body schema: application/json

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "valid@email.com"
}

Response samples

200
422

Content type

application/json

{ }

Resets password for user

Request Body schema: application/json

token required	string
password required	string (password) min. 8 characters, min. one capital letter, min. one digit, min. one special character

Responses

Request samples

Payload

Content type

application/json

{"token": "3zttghdxh6yzp7tv1bh1w9hy",
"password": "Password100!"
}

Response samples

200
403
410
422

Content type

application/json

{ }

Sets new password for user

Request Body schema: application/json

token required	string
password required	string (password) min. 8 characters, min. one capital letter, min. one digit, min. one special character

Responses

Request samples

Payload

Content type

application/json

{"token": "3zttghdxh6yzp7tv1bh1w9hy",
"password": "Password100!"
}

Response samples

200
403
410
422

Content type

application/json

{"session": {"user": {"id": 27,
"email": "silvana@littel.example",
"first_name": "Margart",
"last_name": "Larkin",
"phone_number": "3725345366",
"user_role": "fleet_driver",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-18T13:36:46.224Z",
"identifier": "a372b653dd5bb41868a160ab5b3b18eb8721dcc8f8d469998010316d5946155a",
"company": {"id": 29,
"company_type": "fleet",
"email": "jackie_kohler@streich.example",
"name": "Jene Lynch",
"onboarded": true,
"confirmed_at": "2025-02-18T13:36:46.226Z",
"phone_number": "9308233493",
"address": {"id": 29,
"full_address": "Apt. 800 74508 Ray Meadow, Rempelmouth, CT 84909",
"latitude": 60.61,
"longitude": 75.02,
"state": {"id": 46,
"full_name": "Sen. Xochitl Daniel",
"short_name": "Isaiah McGlynn"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
},
"access_token": {"access_token": "TlMozBSUGyO6w-lZMx8Ag6u6kmRnmU3Ggwnofr7oX1g",
"token_type": "Bearer",
"expires_in": 7200,
"refresh_token": "6P2INuVouQgXoaZEJLaAD6GGtSwzJBiOtinlhzGe64o",
"created_at": 1739885806,
"user_id": 27
}
}
}

Updates password for user

Authorizations:

Bearer Token

Request Body schema: application/json

current_password required	string
password required	string (password) min. 8 characters, min. one capital letter, min. one digit, min. one special character

Responses

Request samples

Payload

Content type

application/json

{"current_password": "OldPassword100!",
"password": "NewPassword200!"
}

Response samples

200
403
422

Content type

application/json

{ }

[Mobile] Accident files

Create accident file

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

file	string <binary> Max file size: 500 MB, allowed extensions: .heic, .jpeg, .jpg, .png, .svg, .avi, .hevc, .mov, .mp4, .mpeg4, .wmv

Responses

Response samples

201
403
422

Content type

application/json

{"id": "f0c64fc9-6e70-496c-ace5-3ed71251ebbe",
"name": "example20250218-64-p4yvh1.jpeg",
"url": "http://minio:9000/mayer-test/store/f3bcec225fe95c36512dc2e521b7fb68.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=mayer-minio%2F20250218%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20250218T133646Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=aaefb4a37b6bacbbc6888397adeb6e1a08cb7ed76fe58e8e9b44c35e8d33f62b",
"size": 0,
"type": "image",
"extension": "jpeg"
}

Delete accident file

Authorizations:

Bearer Token

path Parameters

uuid

required

string

Responses

Response samples

404
409

Content type

application/json

{"error": {"code": "fetch_file",
"details": [{"key": "_base",
"message": "File is not found"
}
]
}
}

[Mobile] Accident forms

Show accident form

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

{"id": 3,
"sections": [{"id": 1,
"position": 1,
"title": "First respondents on scene",
"questions": [{"id": 2,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Have you or someone else called 911?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 1,
"value": "Yes"
},
{"id": 2,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 3,
"array": false,
"optional": true,
"question_type": "multi_select",
"tag": null,
"title": "Choose multiple options",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 3,
"value": "Police"
},
{"id": 4,
"value": "Firefighters"
},
{"id": 5,
"value": "Ambulance"
},
{"id": 6,
"value": "Other"
}
],
"depending_answer_id": 1,
"depending_question_id": 2
}
],
"components": [{"id": 1,
"array": false,
"tag": "call911",
"title": null,
"description": null,
"depending_answer_id": 2,
"position": null
}
]
},
{"id": 2,
"position": 2,
"title": "Add your phone number and current time",
"questions": [{"id": 4,
"array": false,
"optional": false,
"question_type": "phone",
"tag": "driver_phone_number",
"title": "Your phone number",
"placeholder": "Phone number",
"description": null,
"possible_answers": [ ],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 5,
"array": false,
"optional": false,
"question_type": "date",
"tag": "accident_date",
"title": "Accident date",
"placeholder": "Accident date",
"description": null,
"possible_answers": [ ],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 6,
"array": false,
"optional": false,
"question_type": "time",
"tag": "accident_time",
"title": "Accident time",
"placeholder": "Accident time",
"description": null,
"possible_answers": [ ],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 3,
"position": 3,
"title": "Accident site",
"questions": [{"id": 7,
"array": false,
"optional": false,
"question_type": "current_address",
"tag": "accident_address",
"title": "Accident address",
"placeholder": null,
"description": null,
"possible_answers": [ ],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 4,
"position": 4,
"title": "Tractor number and trailer number",
"questions": [{"id": 8,
"array": false,
"optional": false,
"question_type": "text",
"tag": "tractor_number",
"title": "Tractor number",
"placeholder": "Tractor number",
"description": null,
"possible_answers": [ ],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 9,
"array": true,
"optional": true,
"question_type": "text",
"tag": "trailer_number",
"title": "Trailer number",
"placeholder": "Trailer number",
"description": null,
"possible_answers": [ ],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 5,
"position": 5,
"title": "Personal injuries",
"questions": [{"id": 10,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Were there any injuries?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 7,
"value": "Yes"
},
{"id": 8,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 6,
"position": 6,
"title": "Severity of injuries",
"questions": [{"id": 11,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": "severity_level",
"title": "What is the severity of injuries?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 9,
"value": "Slight"
},
{"id": 10,
"value": "Serious"
},
{"id": 11,
"value": "Fatal"
}
],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 7,
"position": 7,
"title": "Citation issued",
"questions": [{"id": 12,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Was a citation issued?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 12,
"value": "Yes"
},
{"id": 13,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 13,
"array": false,
"optional": true,
"question_type": "multi_select",
"tag": null,
"title": "What did you get charged for?",
"placeholder": "Charge description",
"description": null,
"possible_answers": [{"id": 14,
"value": "Speeding"
},
{"id": 15,
"value": "Running a red light"
},
{"id": 16,
"value": "Other"
}
],
"depending_answer_id": 12,
"depending_question_id": 12
},
{"id": 14,
"array": false,
"optional": true,
"question_type": "file",
"tag": null,
"title": "Attach your ticket",
"placeholder": null,
"description": null,
"possible_answers": [ ],
"depending_answer_id": 12,
"depending_question_id": 12
}
],
"components": [ ]
},
{"id": 8,
"position": 8,
"title": "Towaway",
"questions": [{"id": 15,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Towaway required?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 17,
"value": "Yes"
},
{"id": 18,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 16,
"array": false,
"optional": true,
"question_type": "text",
"tag": null,
"title": "Towing company name",
"placeholder": "Towing company name",
"description": null,
"possible_answers": [ ],
"depending_answer_id": 17,
"depending_question_id": 15
},
{"id": 17,
"array": false,
"optional": true,
"question_type": "text",
"tag": null,
"title": "Contact data of tow company",
"placeholder": "Add contact data of tow company",
"description": null,
"possible_answers": [ ],
"depending_answer_id": 17,
"depending_question_id": 15
}
],
"components": [ ]
},
{"id": 9,
"position": 9,
"title": "Involved Persons",
"questions": [{"id": 18,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Where there any involved persons?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 19,
"value": "Yes"
},
{"id": 20,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 19,
"array": true,
"optional": true,
"question_type": "personal_data",
"tag": "claimer",
"title": "Involved person",
"placeholder": null,
"description": "Enter involved person data",
"possible_answers": [ ],
"depending_answer_id": 19,
"depending_question_id": 18
}
],
"components": [ ]
},
{"id": 10,
"position": 10,
"title": "Witnesses",
"questions": [{"id": 20,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Where there any witnesses?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 21,
"value": "Yes"
},
{"id": 22,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 21,
"array": true,
"optional": true,
"question_type": "personal_data",
"tag": "witness",
"title": "Witness",
"placeholder": null,
"description": "Enter witness data",
"possible_answers": [ ],
"depending_answer_id": 21,
"depending_question_id": 20
}
],
"components": [ ]
},
{"id": 11,
"position": 11,
"title": "Surveillance video",
"questions": [{"id": 22,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Was there surveillance nearby?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 23,
"value": "Yes"
},
{"id": 24,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 23,
"array": false,
"optional": true,
"question_type": "address",
"tag": null,
"title": "Provide surveillance address",
"placeholder": null,
"description": null,
"possible_answers": [ ],
"depending_answer_id": 23,
"depending_question_id": 22
},
{"id": 24,
"array": false,
"optional": true,
"question_type": "file",
"tag": null,
"title": "Photo of the place with surveillance video",
"placeholder": null,
"description": null,
"possible_answers": [ ],
"depending_answer_id": 23,
"depending_question_id": 22
}
],
"components": [ ]
},
{"id": 12,
"position": 12,
"title": "Photos and videos",
"questions": [{"id": 25,
"array": true,
"optional": true,
"question_type": "file",
"tag": null,
"title": "Upload photos and videos of the accident",
"placeholder": null,
"description": null,
"possible_answers": [ ],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 13,
"position": 13,
"title": "Description of the accident",
"questions": [{"id": 26,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": "description",
"title": "Description of the accident",
"placeholder": "Description of the accident",
"description": null,
"possible_answers": [{"id": 25,
"value": "Backing"
},
{"id": 26,
"value": "Side swipe"
},
{"id": 27,
"value": "Rear end"
},
{"id": 28,
"value": "Head on"
},
{"id": 29,
"value": "Left hand turn"
},
{"id": 30,
"value": "Right hand turn"
}
],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 14,
"position": 14,
"title": "GPS device",
"questions": [{"id": 27,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Does your Tractor have a dash camera and/or GPS device",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 31,
"value": "Yes"
},
{"id": 32,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
}
],
"components": [ ]
},
{"id": 15,
"position": 15,
"title": "Drugs and alcohol test",
"questions": [{"id": 28,
"array": false,
"optional": false,
"question_type": "single_select",
"tag": null,
"title": "Was a drug or alcohol test performed?",
"placeholder": null,
"description": null,
"possible_answers": [{"id": 33,
"value": "Yes"
},
{"id": 34,
"value": "No"
}
],
"depending_answer_id": null,
"depending_question_id": null
},
{"id": 29,
"array": false,
"optional": true,
"question_type": "text",
"tag": null,
"title": "Attach drug test result",
"placeholder": null,
"description": null,
"possible_answers": [ ],
"depending_answer_id": 33,
"depending_question_id": 28
}
],
"components": [ ]
}
]
}

[Mobile] Accident reports

Create accident report

Authorizations:

Bearer Token

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"answers": [{"question_id": 0,
"value": "string",
"possible_answer_id": 0,
"object": { },
"accident_file_id": "string"
}
]
}

Response samples

201
403
404
422

Content type

application/json

Example

with values key

{"id": 3,
"accident": {"id": 3,
"claim_number": 226992637,
"form_url": "https://example.com/cases/form?token=52b6b9c6b8b1d3fd5b1c9a25f2a07f628b9b787ab511199a546a0611266b78ca",
"remaining_edit_time": 7199,
"address": {"id": 66,
"full_address": "Magazynowa 34, Oława, Dorthy Hermiston 55-200",
"latitude": 0,
"longitude": 0,
"state": {"id": 81,
"full_name": "Dorthy Hermiston",
"short_name": "Jeremy Ortiz"
}
}
},
"accident_form": {"id": 9,
"sections": [ ]
},
"answers": [{"id": 2,
"question_id": 170,
"value": null,
"possible_answer_id": null,
"object": {"city": "Oława",
"state": "Dorthy Hermiston",
"zip_code": "55-200",
"street_name": "Magazynowa 34"
},
"accident_file": null
},
{"id": 3,
"question_id": 171,
"value": "+1 336 358 6565",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 4,
"question_id": 172,
"value": "2024-01-01",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 5,
"question_id": 173,
"value": "11:00",
"possible_answer_id": null,
"object": null,
"accident_file": null
}
]
}

List accident reports

Authorizations:

Bearer Token

Responses

Response samples

200
403

Content type

application/json

[{"id": 9,
"accident": {"id": 9,
"claim_number": 196708671,
"form_url": "https://example.com/cases/form?token=93dace5304458115ba0298604f004a77f0754203b85f6e90780696e484047b1a",
"remaining_edit_time": 7199,
"address": {"id": 99,
"full_address": "696 Laurice Locks, Port Harleyville, SD 96857",
"latitude": 46.57,
"longitude": 35.13,
"state": {"id": 111,
"full_name": "Dr. Elin Hessel",
"short_name": "Klara Reilly LLD"
}
}
}
},
{"id": 8,
"accident": {"id": 8,
"claim_number": 825788911,
"form_url": "https://example.com/cases/form?token=bcefcedc974390c6a12e5dfd534073c839d58d171ae9e4288e132eea41e3afed",
"remaining_edit_time": 7199,
"address": {"id": 94,
"full_address": "Apt. 338 21120 Marisha Mission, Lake Zanestad, OR 75818",
"latitude": 94.75,
"longitude": 78.32,
"state": {"id": 106,
"full_name": "Devin Rohan",
"short_name": "Karey Bode"
}
}
}
}
]

Show accident report

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

{"id": 12,
"accident": {"id": 12,
"claim_number": 536520258,
"form_url": "https://example.com/cases/form?token=db8775e8d8e7e1539d6d4494955e402cd903555dea899c77e2254f1873fa0a68",
"remaining_edit_time": 7199,
"address": {"id": 116,
"full_address": "56646 Runte Springs, McDermottville, OR 18616",
"latitude": 97.39,
"longitude": 40.97,
"state": {"id": 128,
"full_name": "Dwight Olson",
"short_name": "Ms. Numbers Hermann"
}
}
},
"accident_form": {"id": 25,
"sections": [ ]
},
"answers": [{"id": 17,
"question_id": 193,
"value": "2515958987",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 18,
"question_id": 194,
"value": "Answer 1",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 19,
"question_id": 194,
"value": "Answer 2",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 20,
"question_id": 195,
"value": null,
"possible_answer_id": null,
"object": {"city": "Oława",
"state": "Lester Fisher",
"zip_code": "55-200",
"street_name": "Magazynowa 34"
},
"accident_file": null
}
]
}

Update accident report

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"answers": [{"id": 0,
"question_id": 0,
"value": "string",
"possible_answer_id": 0,
"object": { },
"accident_file_id": "string"
}
]
}

Response samples

200
403
404
422

Content type

application/json

Example

with new address coordinates

{"id": 16,
"accident": {"id": 16,
"claim_number": 752901767,
"form_url": "https://example.com/cases/form?token=fb99c3b1d1faf96a6761b0290e7a4415706e072ac6087a54ad32398643fca8b2",
"remaining_edit_time": 7199,
"address": {"id": 141,
"full_address": "Ebury, London, Gov. Cary Reichel SW1W 0NY",
"latitude": 0,
"longitude": 0,
"state": {"id": 151,
"full_name": "Gov. Cary Reichel",
"short_name": "Leatrice Bednar"
}
}
},
"accident_form": {"id": 29,
"sections": [ ]
},
"answers": [{"id": 33,
"question_id": 206,
"value": "new value",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 34,
"question_id": 205,
"value": null,
"possible_answer_id": null,
"object": {"city": "London",
"state": "Gov. Cary Reichel",
"zip_code": "SW1W 0NY",
"street_name": "Ebury"
},
"accident_file": null
}
]
}

Validate accident report

Validates accident report's questions. Doesn't require complete set of answers.

Authorizations:

Bearer Token

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"answers": [{"question_id": 0,
"value": "string",
"possible_answer_id": 0,
"object": { },
"accident_file_id": "string"
}
]
}

Response samples

403
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

[Web] Accident files

Create accident file

Authorizations:

Bearer Token

Request Body schema: multipart/form-data

file	string <binary> Max file size: 500 MB

Responses

Response samples

201
403
422

Content type

application/json

{"id": "ef8a60ce-ba6d-4f34-b527-ee481100e660",
"name": "example20250218-64-7a3eoe.jpeg",
"url": "http://minio:9000/mayer-test/store/0c14f4e648c1f0e984b244c1a716766a.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=mayer-minio%2F20250218%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20250218T133650Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=c13034cd91f8c29fc58537ac0f8d853b31a81dab4958bf2ced27e97dee88d75f",
"size": 0,
"type": "image",
"extension": "jpeg"
}

[Web] Accident reports

Create accident report

Authorizations:

Bearer Token

Request Body schema: application/json

accident_id	integer
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"accident_id": 0,
"answers": [{"question_id": 0,
"value": "string",
"possible_answer_id": 0,
"object": { },
"accident_file_id": "string"
}
]
}

Response samples

201
403
404
409
422

Content type

application/json

{"id": 26,
"accident_form": {"id": 43,
"sections": [ ]
},
"answers": [{"id": 42,
"question_id": 221,
"value": null,
"possible_answer_id": null,
"object": {"city": "Oława",
"state": "Margarito White",
"zip_code": "55-200",
"street_name": "Magazynowa 34"
},
"accident_file": null
},
{"id": 43,
"question_id": 222,
"value": "+1 336 358 6565",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 44,
"question_id": 223,
"value": "2024-01-01",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 45,
"question_id": 224,
"value": "11:00",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 46,
"question_id": 225,
"value": null,
"possible_answer_id": null,
"object": {"email": "john.doe@example.com",
"last_name": "Doe",
"first_name": "John",
"phone_number": "+13363586565"
},
"accident_file": null
},
{"id": 47,
"question_id": 225,
"value": null,
"possible_answer_id": null,
"object": {"email": "jane.doe@example.com",
"last_name": "Doe",
"first_name": "Jane",
"phone_number": "+13363586565"
},
"accident_file": null
}
]
}

Update accident report

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

Array of objects

Responses

Request samples

Payload

Content type

application/json

{"answers": [{"id": 0,
"claim_id": 0,
"question_id": 0,
"value": "string",
"possible_answer_id": 0,
"object": { },
"accident_file_id": "string"
}
]
}

Response samples

200
403
404
422

Content type

application/json

Example

when given claim is deleted

{ }

[WEB] Accidents

Submits details

Request Body schema: application/json

token	string
role required	string Enum: "Claimer" "Witness"
first_name required	string
last_name required	string
email required	string
phone_number required	string
description required	string or null

Responses

Request samples

Payload

Content type

application/json

{"token": "token",
"role": "Claimer",
"first_name": "John",
"last_name": "Doe",
"email": "claimer@example.com",
"phone_number": "2515958987",
"description": "I need help"
}

Response samples

404
422

Content type

application/json

{"error": {"code": "fetch_accident",
"details": [{"key": "_base",
"message": "Accident not found"
}
]
}
}

[WEB] Admins

Request password reset for admin

Request Body schema: application/json

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "valid@email.com"
}

Response samples

200
422

Content type

application/json

Example

everything is fine

{ }

Changes password for admin

Request Body schema: application/json

token required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"token": "3zttghdxh6yzp7tv1bh1w9hy",
"password": "Password100!"
}

Response samples

200
403
410
422

Content type

application/json

{ }

Sets new password for admin

Request Body schema: application/json

token required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"token": "3zttghdxh6yzp7tv1bh1w9hy",
"password": "Password100!"
}

Response samples

200
403
410
422

Content type

application/json

{"session": {"user": {"id": 19,
"email": "lyn@nitzsche.example",
"first_name": "Dalia",
"last_name": "Johns",
"phone_number": "3637603703",
"user_role": "admin",
"confirmed_at": "2025-02-18T13:36:51.958Z"
},
"access_token": {"access_token": "WQO7jchezHtHQvLKvOVvWSja5StPdVVIakI79tA-imM",
"token_type": "Bearer",
"expires_in": 7200,
"refresh_token": "o0hd59jd8GMlJTEo7UcAzbKJmArkLftkJaEe37KxE6s",
"created_at": 1739885811,
"user_id": 19
}
}
}

Updates password for admin

Authorizations:

Bearer Token

Request Body schema: application/json

current_password required	string
password required	string (password) min. 8 characters, min. one capital letter, min. one digit, min. one special character

Responses

Request samples

Payload

Content type

application/json

{"current_password": "OldPassword100!",
"password": "NewPassword200!"
}

Response samples

200
403
422

Content type

application/json

{ }

[WEB] Claims

Accept claim

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
409
422

Content type

application/json

{"id": 47,
"number": 15854952,
"driver": {"id": 119,
"first_name": "Gabriel",
"last_name": "White",
"email": "soo@ward-carter.test"
},
"primary_field_investigator": {"id": 118,
"first_name": "Lashonda",
"last_name": "Krajcik",
"email": "anderson@reichert.test"
},
"supporting_field_investigators": [ ],
"fleet_company": {"id": 290,
"email": "jess@tremblay.test",
"name": "Ima Klocko"
},
"field_investigation_company": {"id": 293,
"email": "bobbye@schowalter.example",
"name": "Clarence Abbott"
},
"law_company": {"id": 294,
"email": "odilia@champlin-kris.example",
"name": "Dirk Rosenbaum"
},
"related_cases": [ ],
"status": {"value": "gathering_information",
"label": "Gathering information"
},
"current_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
}
],
"full_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"address": {"id": 337,
"full_address": "724 Kulas Port, North Nickolasville, IL 06367",
"latitude": 11.82,
"longitude": 47.66,
"state": {"id": 349,
"full_name": "Keven Bechtelar Esq.",
"short_name": "Chance Jakubowski IV"
}
},
"claimer": null,
"final_statement": null,
"driver_accident_report": {"id": 47,
"accident_form": {"id": 63,
"sections": [ ]
},
"answers": [ ]
},
"field_investigation_accident_report": null,
"chat_id": 30,
"created_at": "2025-02-18T13:36:52.101Z",
"accident_files": [ ],
"accident_id": 47,
"accepted_amount": null
}

Close claim

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
409
422

Content type

application/json

{"id": 59,
"number": 664850834,
"driver": {"id": 137,
"first_name": "Colby",
"last_name": "Lubowitz",
"email": "veronique@jaskolski.example"
},
"primary_field_investigator": null,
"supporting_field_investigators": [ ],
"fleet_company": {"id": 343,
"email": "hank@cole.test",
"name": "Krystina Graham"
},
"field_investigation_company": {"id": 344,
"email": "irving@rutherford.example",
"name": "Vernetta Braun"
},
"law_company": {"id": 345,
"email": "jackson_cronin@blanda.example",
"name": "Federico Schinner"
},
"related_cases": [ ],
"status": {"value": "closed",
"label": "Closed"
},
"current_status_path": [{"value": "pending",
"label": "To accept"
}
],
"full_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"address": {"id": 402,
"full_address": "22281 Schaden Terrace, North Prestonstad, ND 25480",
"latitude": 94.41,
"longitude": 38.97,
"state": {"id": 414,
"full_name": "Elbert Daniel DO",
"short_name": "Carmelo Fay Jr."
}
},
"claimer": null,
"final_statement": null,
"driver_accident_report": {"id": 53,
"accident_form": {"id": 69,
"sections": [ ]
},
"answers": [ ]
},
"field_investigation_accident_report": null,
"chat_id": 42,
"created_at": "2025-02-18T13:36:52.756Z",
"accident_files": [ ],
"accident_id": 59,
"accepted_amount": null
}

Assign claim's companies

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

law_company_id	integer
field_investigation_company_id	integer

Responses

Request samples

Payload

Content type

application/json

{"law_company_id": 0,
"field_investigation_company_id": 0
}

Response samples

200
403
404
409
422

Content type

application/json

{"id": 66,
"number": 671811079,
"driver": {"id": 150,
"first_name": "Rhonda",
"last_name": "Blanda",
"email": "giovanna_crist@nitzsche.test"
},
"primary_field_investigator": null,
"supporting_field_investigators": [ ],
"fleet_company": {"id": 379,
"email": "kim@gibson.example",
"name": "Franklin Kuphal"
},
"field_investigation_company": {"id": 381,
"email": "spencer@schaefer.example",
"name": "Karey Heller"
},
"law_company": {"id": 383,
"email": "hank_erdman@ullrich.example",
"name": "The Hon. Reginia Langworth"
},
"related_cases": [ ],
"status": {"value": "pending",
"label": "To accept"
},
"current_status_path": [{"value": "pending",
"label": "To accept"
}
],
"full_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"address": {"id": 445,
"full_address": "Apt. 791 1776 Hamill Coves, Lake Marcietown, WA 98371",
"latitude": 90.58,
"longitude": 71.53,
"state": {"id": 457,
"full_name": "Maria Hoeger",
"short_name": "Alisa Lesch"
}
},
"claimer": null,
"final_statement": null,
"driver_accident_report": {"id": 60,
"accident_form": {"id": 76,
"sections": [ ]
},
"answers": [ ]
},
"field_investigation_accident_report": null,
"chat_id": 49,
"created_at": "2025-02-18T13:36:53.183Z",
"accident_files": [ ],
"accident_id": 66,
"accepted_amount": null
}

List claims

Authorizations:

Bearer Token

query Parameters

	object
page	integer
items_per_page	integer

Responses

Response samples

200
403
422

Content type

application/json

{"collection": [{"id": 76,
"accident_date": "2024-01-01",
"number": 627160741,
"primary_field_investigator": {"id": 211,
"first_name": "Kimbra",
"last_name": "Hauck",
"email": "shanelle@marquardt.example"
},
"fleet_company": "Haydee Hegmann",
"field_investigation_company": "Cami Nienow",
"law_company": "Rev. Jestine Casper",
"description": "Sed voluptatem ipsa. Molestias quo sapiente. Voluptatem odio sit.",
"tractor_number": "DW 0082",
"severity_level": "Slight",
"status": {"value": "pending",
"label": "To accept"
}
}
],
"pagination": {"items_length": 1,
"page": 1,
"page_count": 1
}
}

Resolve claim

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

amount

integer

in cents

Responses

Request samples

Payload

Content type

application/json

{"amount": 0
}

Response samples

200
403
404
409
422

Content type

application/json

Example

with settlement amount

{"id": 80,
"number": 310989329,
"driver": {"id": 227,
"first_name": "Rosaura",
"last_name": "Kessler",
"email": "calandra@hoeger-hansen.example"
},
"primary_field_investigator": null,
"supporting_field_investigators": [ ],
"fleet_company": {"id": 466,
"email": "verlie.nader@douglas.test",
"name": "Tommie Lowe"
},
"field_investigation_company": {"id": 467,
"email": "fredric@mohr.example",
"name": "Korey Bernhard"
},
"law_company": {"id": 468,
"email": "ginny_jakubowski@lind-hane.test",
"name": "Ardis Jenkins"
},
"related_cases": [ ],
"status": {"value": "finished",
"label": "Finished"
},
"current_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"full_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"address": {"id": 546,
"full_address": "10323 Upton Plains, Harrietteberg, NE 50732-0616",
"latitude": 41.22,
"longitude": 72.48,
"state": {"id": 558,
"full_name": "Dexter Trantow",
"short_name": "Norbert Kub"
}
},
"claimer": null,
"final_statement": null,
"driver_accident_report": {"id": 74,
"accident_form": {"id": 90,
"sections": [ ]
},
"answers": [ ]
},
"field_investigation_accident_report": null,
"chat_id": 59,
"created_at": "2025-02-18T13:36:54.527Z",
"accident_files": [ ],
"accident_id": 80,
"accepted_amount": 100000000
}

Show claim

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

Example

when claim is not closed

{"id": 89,
"number": 654942121,
"driver": {"id": 253,
"first_name": "Ben",
"last_name": "Sipes",
"email": "tessa.veum@turcotte-ward.example"
},
"primary_field_investigator": {"id": 256,
"first_name": "Melia",
"last_name": "Hand",
"email": "floyd@price.test"
},
"supporting_field_investigators": [ ],
"fleet_company": {"id": 528,
"email": "ossie@erdman-lueilwitz.example",
"name": "Msgr. Grazyna Blanda"
},
"field_investigation_company": {"id": 529,
"email": "marge@murazik.test",
"name": "Gerald Brekke"
},
"law_company": {"id": 530,
"email": "oren_kub@feest.example",
"name": "Signe Hilll"
},
"related_cases": [ ],
"status": {"value": "information_analysis",
"label": "Information analysis"
},
"current_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
}
],
"full_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"address": {"id": 619,
"full_address": "76265 Mitchel Spring, West Shaynebury, OR 67398-4329",
"latitude": 32.37,
"longitude": 42.48,
"state": {"id": 631,
"full_name": "Randall Stamm Ret.",
"short_name": "Darron Emmerich"
}
},
"claimer": {"id": 8,
"first_name": "Alphonso",
"last_name": "Towne",
"email": "tera@schumm-mcdermott.test",
"phone_number": "559.457.9154"
},
"final_statement": null,
"driver_accident_report": {"id": 83,
"accident_form": {"id": 99,
"sections": [ ]
},
"answers": [{"id": 75,
"question_id": 263,
"value": "DW 0082",
"possible_answer_id": null,
"object": null,
"accident_file": null
},
{"id": 76,
"question_id": 264,
"value": null,
"possible_answer_id": null,
"object": null,
"accident_file": {"id": "7f850dae-60e4-472f-b051-8c631706696b",
"name": "example.mp4",
"url": "http://minio:9000/mayer-test/store/0c24576667ea5268726118d490ee8215?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=mayer-minio%2F20250218%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20250218T133655Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=08f9503bb3b9f8d14e273370eb594e7364fca618ada392498687da975ee13eca",
"size": 1570024,
"type": "video",
"extension": "mp4"
}
}
]
},
"field_investigation_accident_report": null,
"chat_id": null,
"created_at": "2025-02-18T13:36:55.240Z",
"accident_files": [{"id": "3ca61df4-d013-4989-aaeb-1da9e535b466",
"name": "example-pdf.pdf",
"url": "http://minio:9000/mayer-test/store/360dd70ce1c4866026cba5db2e849e8a?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=mayer-minio%2F20250218%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20250218T133655Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=298856f629f32d7bd8587c70278c1d126bfd7fc3cd69cc6dd56dcff9c7565c83",
"size": 13264,
"type": "other",
"extension": "pdf"
},
{"id": "7f850dae-60e4-472f-b051-8c631706696b",
"name": "example.mp4",
"url": "http://minio:9000/mayer-test/store/0c24576667ea5268726118d490ee8215?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=mayer-minio%2F20250218%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20250218T133655Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=08f9503bb3b9f8d14e273370eb594e7364fca618ada392498687da975ee13eca",
"size": 1570024,
"type": "video",
"extension": "mp4"
}
],
"accident_id": 89,
"accepted_amount": null
}

[Web] Claim files

Create accident file

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: multipart/form-data

file	string <binary> Max file size: 500 MB
filename	string Without extension

Responses

Response samples

201
403
404
409
422

Content type

application/json

{"id": "07fe6547-664b-4f67-a74f-b090d4a67199",
"name": "new-file.jpeg",
"url": "http://minio:9000/mayer-test/store/26f0da4b551c2fb9949cb7d77c7c6a24.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=mayer-minio%2F20250218%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20250218T133652Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=559864131d8bd0ec7e906fd8245c0dd1c706a20ec2afcd7e4806a88838a32cca",
"size": 0,
"type": "image",
"extension": "jpeg"
}

[WEB] Field Investigation Companies

Create field investigation company

Authorizations:

Bearer Token

Request Body schema: application/json

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

201
403
409
422

Content type

application/json

{ }

[WEB] Field Investigation Workers

Creates field investigation worker

Authorizations:

Bearer Token

Request Body schema: application/json

email	string
first_name	string
last_name	string
phone_number	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string"
}

Response samples

201
403
409
422

Content type

application/json

{"id": 280,
"email": "email@exampl.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": "2515958987",
"user_role": "field_investigator_worker",
"confirmation_status": {"value": "invitation_sent",
"label": "Invitation sent"
},
"confirmed_at": null,
"identifier": null,
"company": {"id": 558,
"company_type": "fleet",
"email": "shante@rogahn.test",
"name": "Alphonso Lockman",
"onboarded": false,
"confirmed_at": null,
"phone_number": "4187213997",
"address": {"id": 649,
"full_address": "974 Gale Knoll, Port Nganmouth, TN 02664-1627",
"latitude": 58.52,
"longitude": 96.32,
"state": {"id": 661,
"full_name": "Maryland O'Connell",
"short_name": "Pedro Fadel"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": 0
}

Get field investigation workers

Authorizations:

Bearer Token

query Parameters

	object
page	integer
items_per_page	integer

Responses

Response samples

200
403

Content type

application/json

{"collection": [{"id": 299,
"email": "meredith@legros-runolfsson.test",
"first_name": "Charis",
"last_name": "Langworth",
"phone_number": "3070752442",
"user_role": "field_investigator_worker",
"confirmation_status": {"value": "invitation_expired",
"label": "Invitation expired"
},
"confirmed_at": null,
"identifier": "0772c66f1039e2017a2a92f45ae9e5661f9e80d59128c4ec46106ac572ff6614",
"company": {"id": 575,
"company_type": "field_investigation",
"email": "refugio@weber.test",
"name": "Matha Hand",
"onboarded": false,
"confirmed_at": null,
"phone_number": "6920737821",
"address": {"id": 666,
"full_address": "Suite 519 4730 Lon Mountain, West Osvaldobury, VT 11566-6914",
"latitude": 34.44,
"longitude": 15.16,
"state": {"id": 678,
"full_name": "Arnoldo Hyatt JD",
"short_name": "Constance Harber"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": 0
},
{"id": 298,
"email": "zana.harris@von.test",
"first_name": "Malik",
"last_name": "Huel",
"phone_number": "2081340268",
"user_role": "field_investigator_worker",
"confirmation_status": {"value": "invitation_sent",
"label": "Invitation sent"
},
"confirmed_at": null,
"identifier": "62d89b3314952561538b6f3ce3ec318a2270b685fd3f9010bbbb40ba393935f5",
"company": {"id": 575,
"company_type": "field_investigation",
"email": "refugio@weber.test",
"name": "Matha Hand",
"onboarded": false,
"confirmed_at": null,
"phone_number": "6920737821",
"address": {"id": 666,
"full_address": "Suite 519 4730 Lon Mountain, West Osvaldobury, VT 11566-6914",
"latitude": 34.44,
"longitude": 15.16,
"state": {"id": 678,
"full_name": "Arnoldo Hyatt JD",
"short_name": "Constance Harber"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": 0
},
{"id": 297,
"email": "gaston_breitenberg@schaefer.test",
"first_name": "Fe",
"last_name": "Hintz",
"phone_number": "6411689711",
"user_role": "field_investigator_worker",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:56.028Z",
"identifier": "89bcd536277cc04458d745d49b3949cbcddae40a08b24909680acdf900324437",
"company": {"id": 575,
"company_type": "field_investigation",
"email": "refugio@weber.test",
"name": "Matha Hand",
"onboarded": false,
"confirmed_at": null,
"phone_number": "6920737821",
"address": {"id": 666,
"full_address": "Suite 519 4730 Lon Mountain, West Osvaldobury, VT 11566-6914",
"latitude": 34.44,
"longitude": 15.16,
"state": {"id": 678,
"full_name": "Arnoldo Hyatt JD",
"short_name": "Constance Harber"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": 0
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

Destroys field investigation worker

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

{ }

Shows field investigation worker

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

{"id": 308,
"email": "vesta.strosin@crona.example",
"first_name": "Royal",
"last_name": "Lehner",
"phone_number": "9634235491",
"user_role": "field_investigator_worker",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:56.131Z",
"identifier": "2e6e5d463abc1cedb4bdfb55ac1f71684e7a77f784cf3aebf060b2dab198d210",
"company": {"id": 580,
"company_type": "field_investigation",
"email": "ramiro@ondricka-nitzsche.example",
"name": "Earle Olson",
"onboarded": true,
"confirmed_at": null,
"phone_number": "1707380477",
"address": {"id": 671,
"full_address": "Suite 590 271 Kemmer Trail, South Towandashire, OK 56586-5715",
"latitude": 72.89,
"longitude": 41.15,
"state": {"id": 683,
"full_name": "Leida Lindgren",
"short_name": "Gita Buckridge"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": 0
}

Updates field investigation worker

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

first_name	string
last_name	string
phone_number	string
identifier	string

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"phone_number": "string",
"identifier": "string"
}

Response samples

200
403
404
422

Content type

application/json

{"id": 318,
"email": "lenny@rodriguez-schiller.test",
"first_name": "New First Name",
"last_name": "New Last Name",
"phone_number": "2515958987",
"user_role": "field_investigator_worker",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:56.268Z",
"identifier": "964dd105bcca4f28ed3d135f190c58ecb6dc0053e31ffda94c8e59a7ba005dda",
"company": {"id": 590,
"company_type": "fleet",
"email": "inocencia@watsica.example",
"name": "Reinaldo Kshlerin Sr.",
"onboarded": true,
"confirmed_at": null,
"phone_number": "6349886127",
"address": {"id": 681,
"full_address": "Suite 963 8156 Abshire Pike, Joshuafurt, AL 86708",
"latitude": 46.82,
"longitude": 95.91,
"state": {"id": 693,
"full_name": "Dr. Bernardo Schinner",
"short_name": "Irwin McClure"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": 0
}

[WEB] Fleet Companies

Create fleet company

Authorizations:

Bearer Token

Request Body schema: application/json

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

201
403
409
422

Content type

application/json

{ }

Get fleet companies

Get fleet companies sorted by creation date in descending order.

Authorizations:

Bearer Token

query Parameters

	object
page	integer
items_per_page	integer

Responses

Response samples

200
422

Content type

application/json

{"collection": [{"id": 657,
"company_type": "fleet",
"email": "luther_hane@dooley.test",
"name": "Tabetha Reinger LLD",
"onboarded": false,
"confirmed_at": null,
"phone_number": "9668852489",
"address": {"id": 747,
"full_address": "Apt. 226 34881 Moen Corner, North Marylynnburgh, AR 30300-2684",
"latitude": 38.01,
"longitude": 70.17,
"state": {"id": 759,
"full_name": "Sheba Rowe MD",
"short_name": "Reginald Ankunding"
}
},
"states": [{"id": 761,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
},
{"id": 656,
"company_type": "fleet",
"email": "olevia_schaden@cummings-stamm.example",
"name": "Rodney Quigley",
"onboarded": false,
"confirmed_at": null,
"phone_number": "7903294318",
"address": {"id": 746,
"full_address": "Suite 841 54910 Francisco Road, New Waylonmouth, IL 61114-9802",
"latitude": 94.57,
"longitude": 39.36,
"state": {"id": 758,
"full_name": "Marinda McKenzie",
"short_name": "Soon Walker"
}
},
"states": [{"id": 760,
"full_name": "Alabama",
"short_name": "AL"
},
{"id": 761,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
}
],
"pagination": {"items_length": 2,
"page": 1,
"page_count": 1
}
}

Delete fleet company

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

{ }

[WEB] Fleet Drivers

Creates fleet's driver

Authorizations:

Bearer Token

Request Body schema: application/json

email	string
first_name	string
last_name	string
phone_number	string
identifier	string

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"first_name": "string",
"last_name": "string",
"phone_number": "string",
"identifier": "string"
}

Response samples

201
403
409
422

Content type

application/json

{"id": 336,
"email": "email@exampl.com",
"first_name": "John",
"last_name": "Doe",
"phone_number": "2515958987",
"user_role": "fleet_driver",
"confirmation_status": {"value": "invitation_sent",
"label": "Invitation sent"
},
"confirmed_at": null,
"identifier": "123",
"company": {"id": 613,
"company_type": "fleet",
"email": "minnie@gusikowski-feeney.test",
"name": "Sherwood Williamson CPA",
"onboarded": true,
"confirmed_at": null,
"phone_number": "9656076936",
"address": {"id": 703,
"full_address": "Suite 547 848 Lavonda Forest, New Wiltonfort, MA 57267",
"latitude": 61.83,
"longitude": 89.62,
"state": {"id": 715,
"full_name": "Glennis Boyer III",
"short_name": "Silva Jacobi"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
}

Get fleet drivers

Get fleet drivers sorted by creation date in descending order.

Authorizations:

Bearer Token

query Parameters

	object
page	integer
items_per_page	integer

Responses

Response samples

200
403

Content type

application/json

{"collection": [{"id": 357,
"email": "nilsa_lubowitz@mcdermott-rempel.example",
"first_name": "Sunday",
"last_name": "Kunze",
"phone_number": "3046638593",
"user_role": "fleet_driver",
"confirmation_status": {"value": "invitation_expired",
"label": "Invitation expired"
},
"confirmed_at": null,
"identifier": "ca4ef2567ee07b7a91992e4120b4d8c6b32ebeda92ad912d478a0e44f7a027f5",
"company": {"id": 631,
"company_type": "fleet",
"email": "quentin_heathcote@ebert-schuppe.example",
"name": "Rep. Ciera Bode",
"onboarded": false,
"confirmed_at": null,
"phone_number": "8574967543",
"address": {"id": 721,
"full_address": "Apt. 726 874 Breitenberg Falls, O'Konborough, WY 57502",
"latitude": 46.26,
"longitude": 67.78,
"state": {"id": 733,
"full_name": "Kimberley Schultz",
"short_name": "Dell Bahringer"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
},
{"id": 356,
"email": "apryl@marks-brown.example",
"first_name": "Lashawna",
"last_name": "Skiles",
"phone_number": "3002872093",
"user_role": "fleet_driver",
"confirmation_status": {"value": "invitation_sent",
"label": "Invitation sent"
},
"confirmed_at": null,
"identifier": "f19c9369bff97d1ca9c663b9a399ed97c955e15863f0779e913b02c24e5d2e47",
"company": {"id": 631,
"company_type": "fleet",
"email": "quentin_heathcote@ebert-schuppe.example",
"name": "Rep. Ciera Bode",
"onboarded": false,
"confirmed_at": null,
"phone_number": "8574967543",
"address": {"id": 721,
"full_address": "Apt. 726 874 Breitenberg Falls, O'Konborough, WY 57502",
"latitude": 46.26,
"longitude": 67.78,
"state": {"id": 733,
"full_name": "Kimberley Schultz",
"short_name": "Dell Bahringer"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
},
{"id": 355,
"email": "karissa@toy.test",
"first_name": "Clelia",
"last_name": "Kulas",
"phone_number": "6849607142",
"user_role": "fleet_driver",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:57.109Z",
"identifier": "e53f4a8e5ad507bb6608b2bd2b05b0fa99a7c53588bfd4737f759b36da8d5807",
"company": {"id": 631,
"company_type": "fleet",
"email": "quentin_heathcote@ebert-schuppe.example",
"name": "Rep. Ciera Bode",
"onboarded": false,
"confirmed_at": null,
"phone_number": "8574967543",
"address": {"id": 721,
"full_address": "Apt. 726 874 Breitenberg Falls, O'Konborough, WY 57502",
"latitude": 46.26,
"longitude": 67.78,
"state": {"id": 733,
"full_name": "Kimberley Schultz",
"short_name": "Dell Bahringer"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

Removes fleet's driver

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

{ }

Shows fleet's driver

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
403
404
422

Content type

application/json

{"id": 366,
"email": "thomasine@daugherty.example",
"first_name": "Toney",
"last_name": "Bauch",
"phone_number": "4728414654",
"user_role": "fleet_driver",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:57.210Z",
"identifier": "7fd78bbe3eff5015d8e5e91856a350a301b27f0437f6ccf6e4595a7b8914714a",
"company": {"id": 636,
"company_type": "fleet",
"email": "jong@jakubowski-doyle.example",
"name": "Richard Bosco",
"onboarded": false,
"confirmed_at": null,
"phone_number": "3190618736",
"address": {"id": 726,
"full_address": "Suite 103 2762 Kreiger Road, North Leontinetown, NE 23985",
"latitude": 98.72,
"longitude": 74.37,
"state": {"id": 738,
"full_name": "Everett Powlowski I",
"short_name": "Mrs. Aurelio Gerhold"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
}

Updates fleet's driver

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

first_name	string
last_name	string
phone_number	string
identifier	string

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"last_name": "string",
"phone_number": "string",
"identifier": "string"
}

Response samples

200
403
404
422

Content type

application/json

{"id": 376,
"email": "rico.mclaughlin@hills-heaney.test",
"first_name": "New First Name",
"last_name": "New Last Name",
"phone_number": "2515958987",
"user_role": "fleet_driver",
"confirmation_status": {"value": "active",
"label": "Active"
},
"confirmed_at": "2025-02-17T13:36:57.356Z",
"identifier": "new_identifier",
"company": {"id": 646,
"company_type": "fleet",
"email": "anisa@stehr-mckenzie.example",
"name": "Cecil Hartmann",
"onboarded": false,
"confirmed_at": null,
"phone_number": "4701718559",
"address": {"id": 736,
"full_address": "8031 Karol Drive, Jasonton, VT 35523",
"latitude": 67.66,
"longitude": 54.33,
"state": {"id": 748,
"full_name": "Twila Gusikowski V",
"short_name": "The Hon. Cassondra Collier"
}
},
"states": [ ],
"active_claims_number": 0
},
"active_claims_number": null
}

[WEB] Law Companies

Create law company

Authorizations:

Bearer Token

Request Body schema: application/json

email

string

Responses

Request samples

Payload

Content type

application/json

{"email": "string"
}

Response samples

201
403
409
422

Content type

application/json

{ }

[WEB] Companies

Onboard company

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

name	string
email	string
phone_number	string
	object
state_ids	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"phone_number": "string",
"address": {"full_address": "string",
"state_short_name": "string",
"latitude": 0,
"longitude": 0
},
"state_ids": [0
]
}

Response samples

200
403
404
422

Content type

application/json

{"id": 679,
"company_type": "fleet",
"email": "valid@email.com",
"name": "Company name",
"onboarded": true,
"confirmed_at": null,
"phone_number": "2515958987",
"address": {"id": 770,
"full_address": "123 Street one",
"latitude": 50.1,
"longitude": 51.8,
"state": {"id": 789,
"full_name": "one",
"short_name": "1"
}
},
"states": [{"id": 789,
"full_name": "one",
"short_name": "1"
},
{"id": 790,
"full_name": "two",
"short_name": "2"
}
],
"active_claims_number": 0
}

Resend invitation

Authorizations:

Bearer Token

path Parameters

id

required

interger

Responses

Response samples

403
404
422

Content type

application/json

Example

when company is not partner of user's company

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

[WEB] Fleet's Field Investigation Companies

Delete fleet's field investigation partner

Delete field investigation company's partnership with fleet.

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

Get fleet's field investigation partners

Get field investigation companies connected with fleet.

Authorizations:

Bearer Token

query Parameters

	object
page	integer
items_per_page	integer

Responses

Response samples

200
403
422

Content type

application/json

{"collection": [{"id": 720,
"company_type": "field_investigation",
"email": "brunilda_willms@herzog.test",
"name": "Dexter Gibson",
"onboarded": true,
"confirmed_at": null,
"phone_number": "7831123853",
"address": {"id": 816,
"full_address": "Apt. 635 226 Collins Motorway, East Nola, IL 96655-7697",
"latitude": 66.21,
"longitude": 30.16,
"state": {"id": 851,
"full_name": "Eloisa Langworth",
"short_name": "Stacia Littel"
}
},
"states": [{"id": 854,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
},
{"id": 719,
"company_type": "field_investigation",
"email": "wilson.konopelski@leannon-monahan.test",
"name": "Richie Hettinger III",
"onboarded": true,
"confirmed_at": null,
"phone_number": "4373297095",
"address": {"id": 815,
"full_address": "76095 Marketta Islands, Rempelberg, ND 06837",
"latitude": 64.79,
"longitude": 61.24,
"state": {"id": 850,
"full_name": "Dr. Guillermo Pouros",
"short_name": "Jack Gleason"
}
},
"states": [{"id": 853,
"full_name": "Alabama",
"short_name": "AL"
},
{"id": 854,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
}
],
"pagination": {"items_length": 2,
"page": 1,
"page_count": 1
}
}

[WEB] Fleet's Law Partners

Delete fleet's law partner

Delete law company's partnership with fleet.

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

Get fleet's law partners

Get law companies connected with fleet.

Authorizations:

Bearer Token

query Parameters

	object
page	integer
items_per_page	integer

Responses

Response samples

200
403
422

Content type

application/json

{"collection": [{"id": 760,
"company_type": "law",
"email": "martin@weimann.test",
"name": "Alfredo Gleichner",
"onboarded": false,
"confirmed_at": null,
"phone_number": "8916952631",
"address": {"id": 862,
"full_address": "20690 Candi Forest, Rutherfordmouth, NH 41008-2654",
"latitude": 11.81,
"longitude": 39.14,
"state": {"id": 905,
"full_name": "Galen Cole III",
"short_name": "Cordell Johnson"
}
},
"states": [{"id": 908,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
},
{"id": 759,
"company_type": "law",
"email": "marlin@turner.test",
"name": "Dierdre Waters",
"onboarded": true,
"confirmed_at": null,
"phone_number": "7775795030",
"address": {"id": 861,
"full_address": "Suite 468 4373 Ziemann Circles, Auerfort, WY 73317-6223",
"latitude": 14.19,
"longitude": 99.95,
"state": {"id": 904,
"full_name": "Waldo Koch",
"short_name": "Mr. Shaunda Lesch"
}
},
"states": [{"id": 907,
"full_name": "Alabama",
"short_name": "AL"
},
{"id": 908,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
}
],
"pagination": {"items_length": 2,
"page": 1,
"page_count": 1
}
}

[WEB] Company profiles

Show company's profile

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200
404
422

Content type

application/json

{"id": 775,
"company_type": "fleet",
"email": "alvin@moore-grady.example",
"name": "Agatha Lemke Esq.",
"onboarded": false,
"confirmed_at": null,
"phone_number": "6650122342",
"address": {"id": 877,
"full_address": "Apt. 291 300 Borer Stream, New Shauntestad, AZ 81204-3188",
"latitude": 43.09,
"longitude": 55.37,
"state": {"id": 928,
"full_name": "Prof. Thurman Jacobs",
"short_name": "Sheryll Purdy"
}
},
"states": [{"id": 929,
"full_name": "Alabama",
"short_name": "AL"
},
{"id": 930,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
}

Update company's profile

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

name	string
email	string
phone_number	string
	object
state_ids	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"email": "string",
"phone_number": "string",
"address": {"full_address": "string",
"state_short_name": "string",
"latitude": 0,
"longitude": 0
},
"state_ids": [0
]
}

Response samples

200
403
404
422

Content type

application/json

{"id": 779,
"company_type": "fleet",
"email": "valid@email.com",
"name": "Company name",
"onboarded": true,
"confirmed_at": null,
"phone_number": "2515958987",
"address": {"id": 881,
"full_address": "123 Street one",
"latitude": 50.1,
"longitude": 51.8,
"state": {"id": 942,
"full_name": "Alabama",
"short_name": "AL"
}
},
"states": [{"id": 942,
"full_name": "Alabama",
"short_name": "AL"
},
{"id": 943,
"full_name": "Alaska",
"short_name": "AK"
}
],
"active_claims_number": 0
}

[WEB] Claim Final Statement

Create claim's final statement

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

final_statement

string

Responses

Request samples

Payload

Content type

application/json

{"final_statement": "string"
}

Response samples

201
403
404
409
422

Content type

application/json

{"id": 105,
"number": 347513417,
"driver": {"id": 451,
"first_name": "Catherin",
"last_name": "Welch",
"email": "easter.mckenzie@greenfelder.test"
},
"primary_field_investigator": {"id": 450,
"first_name": "Les",
"last_name": "Altenwerth",
"email": "gertie.lueilwitz@kiehn-stracke.example"
},
"supporting_field_investigators": [ ],
"fleet_company": {"id": 812,
"email": "myrtice@becker.test",
"name": "Efrain Doyle"
},
"field_investigation_company": {"id": 809,
"email": "ariane.green@stark-schaden.test",
"name": "Rossana Feil"
},
"law_company": {"id": 811,
"email": "alexander@volkman-williamson.test",
"name": "Vince Jenkins"
},
"related_cases": [ ],
"status": {"value": "settlement_activities",
"label": "Settlement activities"
},
"current_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
}
],
"full_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"address": {"id": 915,
"full_address": "29245 Arron Gateway, West Shirleystad, MA 19926",
"latitude": 50.55,
"longitude": 93.78,
"state": {"id": 990,
"full_name": "Hee Dickens",
"short_name": "Latricia Paucek"
}
},
"claimer": null,
"final_statement": "Itaque suscipit ut. Id illum sequi. Aut qui nulla.",
"driver_accident_report": {"id": 85,
"accident_form": {"id": 102,
"sections": [ ]
},
"answers": [ ]
},
"field_investigation_accident_report": null,
"chat_id": 68,
"created_at": "2025-02-18T13:36:59.615Z",
"accident_files": [ ],
"accident_id": 105,
"accepted_amount": null
}

Update claim's final statement

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

final_statement

string

Responses

Request samples

Payload

Content type

application/json

{"final_statement": "string"
}

Response samples

200
403
404
409
422

Content type

application/json

{"id": 112,
"number": 430968086,
"driver": {"id": 465,
"first_name": "Shayne",
"last_name": "Funk",
"email": "barbar_quigley@abshire.example"
},
"primary_field_investigator": {"id": 464,
"first_name": "Alfonso",
"last_name": "Haag",
"email": "margarito.nolan@cummerata.example"
},
"supporting_field_investigators": [ ],
"fleet_company": {"id": 854,
"email": "dolores_friesen@hane-beahan.test",
"name": "Haywood Waelchi"
},
"field_investigation_company": {"id": 851,
"email": "bernard@jones-zulauf.example",
"name": "Travis Reilly"
},
"law_company": {"id": 853,
"email": "guadalupe@vonrueden.test",
"name": "Elisabeth Rath"
},
"related_cases": [ ],
"status": {"value": "settlement_activities",
"label": "Settlement activities"
},
"current_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
}
],
"full_status_path": [{"value": "pending",
"label": "To accept"
},
{"value": "gathering_information",
"label": "Gathering information"
},
{"value": "information_analysis",
"label": "Information analysis"
},
{"value": "settlement_activities",
"label": "Settlement activities"
},
{"value": "settlement_negotiations",
"label": "Settlement negotiations"
},
{"value": "closing_activities",
"label": "Closing activities"
},
{"value": "finished",
"label": "Finished"
}
],
"address": {"id": 964,
"full_address": "Suite 393 3778 Rickie Village, Lake Allysonview, CT 06486",
"latitude": 13.03,
"longitude": 91.05,
"state": {"id": 1039,
"full_name": "Rolf Vandervort",
"short_name": "January Dietrich"
}
},
"claimer": null,
"final_statement": "Occaecati reprehenderit magni. Fugit praesentium voluptatem. Ea minus molestiae.",
"driver_accident_report": {"id": 92,
"accident_form": {"id": 109,
"sections": [ ]
},
"answers": [ ]
},
"field_investigation_accident_report": null,
"chat_id": 75,
"created_at": "2025-02-18T13:37:00.065Z",
"accident_files": [ ],
"accident_id": 112,
"accepted_amount": null
}

[WEB] Claim Memberships

Creates claim member

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

user_id

integer

Responses

Request samples

Payload

Content type

application/json

{"user_id": 0
}

Response samples

403
404
409
422

Content type

application/json

Example

user role is invalid

{"error": {"code": "unauthorized",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

[WEB] Chat Messages

Creates chat message

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

message

string

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

201
403
404
422

Content type

application/json

{"id": 17,
"text": "Hello",
"settlement_proposal": null,
"json_data": null,
"user_first_name": "Jean",
"user_last_name": "Hickle",
"user_email": "clint.rath@schimmel.example",
"user_company_name": "Greg Kuvalis",
"created_at": "2025-02-18T13:37:01.135Z"
}

Gets chat messages

Authorizations:

Bearer Token

path Parameters

id

required

integer

query Parameters

oldest_item_id

integer

Pass to get previous messages

Responses

Response samples

200
403
404
422

Content type

application/json

Example

without oldest_item_id

{"messages": [{"id": 25,
"text": "Omnis at vel. Quo blanditiis sunt. Rerum ea dolor.",
"settlement_proposal": {"id": 10,
"status": "pending",
"amount": 6458782853
},
"json_data": null,
"user_first_name": null,
"user_last_name": null,
"user_email": null,
"user_company_name": null,
"created_at": "2025-02-18T13:36:01.381Z"
},
{"id": 24,
"text": "Numquam et quidem. Sint tempora libero. Quas excepturi rerum.",
"settlement_proposal": null,
"json_data": null,
"user_first_name": null,
"user_last_name": null,
"user_email": null,
"user_company_name": null,
"created_at": "2025-02-18T13:36:01.380Z"
},
{"id": 23,
"text": "Architecto autem maxime. Neque recusandae officiis. Quibusdam fugiat at.",
"settlement_proposal": null,
"json_data": null,
"user_first_name": "Sterling",
"user_last_name": "Lynch",
"user_email": "marvin_kris@reinger.test",
"user_company_name": "Mary Wolff",
"created_at": "2025-02-18T13:35:01.378Z"
},
{"id": 22,
"text": "Non beatae est. Magni omnis architecto. Et reprehenderit quasi.",
"settlement_proposal": null,
"json_data": null,
"user_first_name": "Sterling",
"user_last_name": "Lynch",
"user_email": "marvin_kris@reinger.test",
"user_company_name": "Mary Wolff",
"created_at": "2025-02-18T11:37:01.377Z"
},
{"id": 21,
"text": "Sed sit saepe. At velit id. Odio odit autem.",
"settlement_proposal": null,
"json_data": null,
"user_first_name": null,
"user_last_name": null,
"user_email": null,
"user_company_name": null,
"created_at": "2025-02-18T10:37:01.375Z"
},
{"id": 20,
"text": "In aut voluptas. Harum ut nostrum. Ea modi necessitatibus.",
"settlement_proposal": null,
"json_data": null,
"user_first_name": "Xavier",
"user_last_name": "Lubowitz",
"user_email": "yetta.ritchie@klocko.example",
"user_company_name": "Clemente Fritsch",
"created_at": "2025-02-18T08:37:01.374Z"
},
{"id": 19,
"text": "Quam sed omnis. Et dolor aut. Inventore nisi eligendi.",
"settlement_proposal": null,
"json_data": null,
"user_first_name": "Adelaida",
"user_last_name": "Botsford",
"user_email": "tabitha_cormier@hackett-oconnell.example",
"user_company_name": "Lynne Kozey",
"created_at": "2025-02-17T13:37:01.372Z"
},
{"id": 18,
"text": "Facere deleniti est. Libero voluptatem sapiente. Voluptate veniam aspernatur.",
"settlement_proposal": null,
"json_data": null,
"user_first_name": "Sterling",
"user_last_name": "Lynch",
"user_email": "marvin_kris@reinger.test",
"user_company_name": "Mary Wolff",
"created_at": "2025-02-16T13:37:01.371Z"
}
],
"pending_proposal": false
}

[WEB] Claim Settlement Proposals

Accepts settlement proposal

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
409
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

Creates settlement proposal

Authorizations:

Bearer Token

path Parameters

id

required

integer

Request Body schema: application/json

amount

integer

in cents

Responses

Request samples

Payload

Content type

application/json

{"amount": 0
}

Response samples

403
404
409
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

Rejects settlement proposal

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
409
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

[WEB] User Notifications

Gets user notifications

Authorizations:

Bearer Token

query Parameters

page	integer
items_per_page	integer

Responses

Response samples

200

Content type

application/json

{"collection": [{"id": 14,
"seen": false,
"notification": {"text": "Minus et et. Excepturi perferendis dolore. Ut in quia.",
"notification_type": "unassigned_case",
"claim_id": 172,
"author": null,
"author_company_name": null
},
"created_at": "2025-02-18T13:37:03.193Z"
},
{"id": 13,
"seen": false,
"notification": {"text": "Dolor ut est. Laborum sit sed. Illum magnam esse.",
"notification_type": "case_assigned",
"claim_id": 171,
"author": null,
"author_company_name": null
},
"created_at": "2025-02-18T13:37:03.192Z"
},
{"id": 12,
"seen": false,
"notification": {"text": "Quae consectetur dicta. Sint quod laudantium. Ducimus nemo ut.",
"notification_type": "accident",
"claim_id": 170,
"author": {"id": 574,
"first_name": "Samuel",
"last_name": "Beahan",
"email": "randy@feeney-smitham.example"
},
"author_company_name": "Marion Wiegand V"
},
"created_at": "2025-02-18T13:37:03.191Z"
}
],
"pagination": {"items_length": 3,
"page": 1,
"page_count": 1
}
}

Reads all user notifications

Authorizations:

Bearer Token

Responses

Reads user notifications

Authorizations:

Bearer Token

Request Body schema: application/json

ids	Array of integers

Responses

Request samples

Payload

Content type

application/json

{"ids": [0
]
}

Response samples

403
404
409
422

Content type

application/json

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

[WEB] Users

Resend invitation

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

403
404
422

Content type

application/json

Example

user role is invalid

{"error": {"code": "authorize",
"details": [{"key": "_base",
"message": "Access forbidden"
}
]
}
}

Get unread notifications count

Authorizations:

Bearer Token

path Parameters

id

required

integer

Responses

Response samples

200

Content type

application/json

{"count": 2
}