Car Body Damage Detection

Inspection of the car body of a vehicle

This endpoint allows you to submit an array of image URLs in the request body to receive a comprehensive car body inspection. Alto AI will provide a more detailed analysis of the vehicle by taking into account multiple viewpoints and angles.

Input	Output
		A customized inspection report can be provided, as well as the JSON file with the detection results so you can design your own report.

The results of the inspection, including any visible license plate numbers will be either returned over a webhook, or can be consulted on our Hub.

Detect the Damages on a List of Vehicle Images - Endpoint

POST https://alto.tchek.fr/apiV1/damage/vehicle

Request Body

Name	Type	Description
urls	Array	List of file URLs. Ex: { "urls": [ "https://tchek-images.s3.eu-west-3.amazonaws.com/swagger/damagedVehicleT34DriverSide.jpeg", "https://tchek-images.s3.eu-west-3.amazonaws.com/swagger/damagedVehiclePassengerSide.jpeg", "https://tchek-images.s3.eu-west-3.amazonaws.com/swagger/damagedVehicleT34PassengerSide.jpeg", "https://tchek-images.s3.eu-west-3.amazonaws.com/swagger/damagedVehicleDriverSide.jpeg" ] }

The results are explained in detail in this article: How to read JSON result

Search Inspections by License Plate and/or Agent Username - Endpoint

This endpoint allows you to search for all inspections linked to one license plate number and/or agent username who issued the self inspection link.

GET https://alto.tchek.fr/apiv1/tchek/search?licensePlate=AA123XX&username=[e-mail]&page=1&limit=3

Request Body

Name	Type	Description
licensePlate	String	The license plate of the inspected vehicle. Ex AB123XX
username	String	The username of the agent who issued the self inspection link. E.g. [e-mail]
limit	integer	The maximum number of results returned by the API
page	integer	The page of the results

Response

200

{
    "data": [
        {
            "id": "AnGHA3QvFi",
            "createdAt": "2024-11-19T13:06:23.457Z",
            "updatedAt": "2025-02-20T09:19:20.920Z",
            "detectionFinished": true,
            "detectionFinishedAt": "2024-11-19T13:13:11.255Z",
            "detectionStartedAt": "2024-11-19T13:12:49.355Z",
            "detectionStatus": false,
            "tchekCreatedAt": "2024-11-19T13:06:23.453Z",
            "damageControl": 22000,
            "numberDamage": 12,
            "numberSevParts": 2,
            "originalNbDamage": 12,
            "fastTrackCompletion": 1,
            "user": {
                "username": "[e-mail]"
            },
            "type": 4,
            "vehicle": {
                "id": "AiklkY3eAc",
                "createdAt": "2024-11-18T16:29:16.081Z",
                "updatedAt": "2024-11-19T13:13:09.652Z",
                "companyPtr": {
                    "id": "AKe7cGEVGi"
                },
                "immat": "AA980WT"
            },
            "isDeleted": false,
            "inspected": true,
            "picturesSelected": {},
            "thumbnailImagePtr": {
                "id": "CMRL1uQRIl",
                "createdAt": "2024-11-19T13:07:42.326Z",
                "updatedAt": "2025-02-20T09:19:20.205Z"
            },
            "modShootInspectEndDate": "2024-11-19T13:27:57.271Z",
            "globalState": "end-inspect",
            "thumbnailUrl": "https://d26lcg3q8zuw55.cloudfront.net/eAJidWNrZXQiOiJ0Y2hla3Byb2QtYjI1NyIsImtleSI6Im9vSDdpQWZnc0QvMG5HSEEzUXZGaS9mcm9udFQzNERyaXZlci5qcGVnIiwiZWRpdHMiOnsicmVzaXplIjp7IndpZHRoIjo0MDAsImhlaWdodCI6NDAwLCJmaXQiOiJvdXRzaWRlIn19fQ==",
            "tradeInToken": {
                "expired": false,
                "id": "Ax1xVhKvY1",
                "createdAt": "2024-11-18T16:29:16.302Z",
                "updatedAt": "2024-11-19T14:32:36.020Z",
                "tradeinVehicle": true,
                "tradeinStatus": 5,
                "tradeinStatusUpdatedAt": "2024-11-19T14:32:35.962Z",
                "sendingType": 1,
                "tchekPtr": {
                    "id": "AnGHA3QvFi",
                    "type": 0,
                    "percentDamage": null
                },
                "uid": "TF9C99A",
                "monitoring": [],
                "deviceId": "TF9C99A-pwa",
                "expiresIn": "2024-12-18T16:29:15.997Z",
                "options": {
                    "fastTrack": false,
                    "shootInspect": true,
                    "cost": false,
                    "report": false,
                    "downloadRoi": false,
                    "loadTchek": true
                }
            }
        },
        {
            "id": "AAD2DwZE7p",
            "createdAt": "2024-11-13T16:14:43.893Z",
            "updatedAt": "2024-11-18T16:28:07.802Z",
            "detectionFinished": true,
            "detectionFinishedAt": "2024-11-13T16:33:10.974Z",
            "detectionStartedAt": "2024-11-13T16:32:50.575Z",
            "detectionStatus": false,
            "tchekCreatedAt": "2024-11-13T16:14:43.891Z",
            "damageControl": 6000,
            "numberDamage": 0,
            "originalNbDamage": 2,
            "fastTrackCompletion": 1,
            "type": 4,
            "vehicle": {
                "id": "AKzLkJQ4Ax",
                "createdAt": "2024-11-13T16:14:16.927Z",
                "updatedAt": "2024-11-13T16:33:09.159Z",
                "companyPtr": {
                    "id": "AKe7cGEVGi"
                },
                "immat": "AA980WT"
            },
            "isDeleted": false,
            "inspected": true,
            "picturesSelected": {},
            "thumbnailImagePtr": {
                "id": "aMYuIW5IAp",
                "createdAt": "2024-11-13T16:29:35.468Z",
                "updatedAt": "2024-11-13T16:33:10.015Z"
            },
            "modShootInspectEndDate": "2024-11-14T14:08:22.121Z",
            "globalState": "end-inspect",
            "thumbnailUrl": "https://d26lcg3q8zuw55.cloudfront.net/eAJidWNrZXQiOiJ0Y2hla3Byb2QtYjI1NyIsImtleSI6Im9vSDdpQWZnc0QvWUFEMkR3WkU3cC9mcm9udFQzNERyaXZlci5qcGVnIiwiZWRpdHMiOnsicmVzaXplIjp7IndpZHRoIjo0MDAsImhlaWdodCI6NDAwLCJmaXQiOiJvdXRzaWRlIn19fQ==",
            "tradeInToken": {
                "expired": false,
                "id": "6EufLfxL6I",
                "createdAt": "2024-11-13T16:14:17.173Z",
                "updatedAt": "2024-11-18T15:08:26.950Z",
                "tradeinVehicle": true,
                "tradeinStatus": 5,
                "tradeinStatusUpdatedAt": "2024-11-18T15:08:26.869Z",
                "sendingType": 2,
                "tchekPtr": {
                    "id": "AAD2DwZE7p",
                    "type": 0,
                    "percentDamage": null
                },
                "uid": "T8B5BCA",
                "monitoring": [],
                "deviceId": "T8B5BCA-pwa",
                "expiresIn": "2024-12-13T16:14:16.924Z",
                "options": {
                    "fastTrack": false,
                    "shootInspect": true,
                    "cost": false,
                    "report": false,
                    "downloadRoi": false,
                    "loadTchek": true
                }
            }
        }
    ],
    "paginationInfo": {
        "totalTcheks": 2,
        "totalPages": 1,
        "currentPage": 1,
        "range": "1-2"
    }
}
```

400

{
  "error": "Invalid request"
}

Name	Type	Description
id	string	Inspection ID
createdAt	date	Date the inspection was created. For self inspection, this is the date the self inspection link was opened.
updatedAt	date	Date the inspection was last updated.
detectionFinishedAt	date	Date the carbody damage detection was finished by ALTO AI
detectionFinished	Boolean	Whether the carbody damage detection was finished by ALTO AI
detectionStartedAt	date	Date the carbody damage detection was started by ALTO AI
detectionStatus	Boolean	Unused,
damageControl	Integer	Time needed for damage review in milliseconds
numberDamage	Integer	Overall number of damages detected on the car
numberSevParts	Integer	Number of affected car parts
originalNbDamage	Integer	Overall number of damages detected on the car before damage review
fastTrackCompletion	Number	0= No damages reviewed during the damage review 1 = All damages reviewed during the damage review
user.username	string	The username of the agent that issued the self inspection token via the Hub or via API (username linked to the creatorUserId)
type	Integer	4= webapp inspection 5= API inspection
isDeleted	Boolean	Whether the inspection has been deleted
inspected	Boolean	Whether the inspection has been deleted
modShootInspectEndDate	Date	The date where the self inspection Shoot inspect step was completed
globalState	string	The overall status of the Webapp self-inspection: 'on-boarding' = Onboarding in progress 'on-boarding' = Onboarding in progress 'form-onboard' = User is filling the form before the Shoot Inspect 'shoot-inspect' = Shoot inspect in progress 'form-offboard' = User is filling the form after the Shoot Inspect fast-track = User is doing the Fast Track damage review (where available) end-inspect' = Self inspection was completed
thumbnailUrl	string	URL to the image to be displayed in the final report intro.

tradeinToken

Name	Type	Description
uid	string	the Unique id of the self inspection token, required to build the URL to the self inspection
id	string	the self inspection token ID on our database, not to be confused with the uId above
createdAt	date	Date the token was created
updatedAt	date	Date the token was updated
expired	Boolean	Whether the self inspection token has expired
tradeinVehicle	Boolean	True if the token is used for a self inspection
tradeinStatus	integer	The status of the self inspection, see Self inspection Token status
tradeinStatusUpdatedAt	date	Date the tradeinStatus was updated
sendingType	integer	See Self Inspection Link Generation
tchekPtr.id	string	The ID of the related inspection
deviceId	string	An ID indicating the inspection device (equal to [uid]-pwa)
expiresIn	date	The date the tradeIn token expires
options	Array	The allowed actions for the self inspection: "shootInspect": true, // whether the final user must take the pictures for the self inspection "fastTrack": false, // whether the final user must do the damage validation after taking the pictures; false if the damages are reviewed by your team or by Tchek "cost": false, // always false for a self-inspection "report": false, // always false for a self-inspection "downloadRoi": false // always false for a self-inspection

thumbnailImagePtr

Name	Type	Description
id	string	Id of the thumbnail
createdAt	date	Date the thumbnail was created
updatedAt	date	Date the thumbnail was updated

vehicle

Name	Type	Description
id	string	Vehicle Id
createdAt	date	Date the vehicle was created
updatedAt	date	Date the vehicle was updated
companyPtr.id	string	The ID of the company
immat	string	The License plate of the vehicle

paginationInfo

Name	Type	Description
totalTcheks	Integer	Number of matching inspections
totalPages	Integer	Number of result pages
currentPage	Integer	Current result page
range	string	Number of results in the page

Get the Results of One Inspection - Endpoint

GET https://alto.tchek.fr/apiv1/tchek/apiV1_sdk/tchek/damagesReport/[tchekID] This endpoint returns the information for an inspection. The results are explained in detail in this article: How to read JSON result

Request Body

Name	Type	Description
tchekId	String	The inspection ID (tchekId) Ex: AA4nM1C46e

The results are explained in detail in this article: How to read JSON result