User Flow - embedding our web widget in your website or app

User Flow - embedding our web widget in your website or app

This example represents how you can further integrate Tchek’s tools (represented by the green boxes) with your own tools (represented by the blue boxes) to offer a completely seamless experience to your customers.

This requires you to integrate our web widget in an iframe (more on this here: Web Widget)

As your leads navigate your website and register, you can send their data to your CRM and use our API to create a Self Inspection SSO token, and with it, the URL to the self inspection page, that you can open in the iframe.

On the webapp, the customer is guided through the necessary steps to capture high-quality images of their vehicle, which are then automatically analyzed by Alto AI for :

  • damage detection (car body, interior elements and/or dashboard warning lights;)

  • license plate reading

  • VIN reading

  • Mileage reading

The customer may also be asked to answer a few questions providing additional details on their vehicle, allowing you to obtain the full picture.

All this valuable information is then made available to you in several forms and on different channels:

  • a webhook notification containing the JSON of the report, complete with links to the original images and to the complete inspection report web page;

  • an email or an SMS, pointing you to the inspection analysis on the Hub, or pointing the client to the final web report.

With Tchek Self Inspection, you can easily leverage the power of Alto AI to streamline your vehicle inspection process and provide valuable data to your customers.

There’s more than one way to get the most of our service!

Configuration

In this section, we will discuss how to configure the tools to create a customized use case for your business.

Whether you are looking to implement a white label inspection process, or simply want to integrate our tools into your existing workflow, we have the flexibility and capabilities to meet your needs.

Creating the self inspection via API

To integrate our Shoot inspect widget in an iframe in their web flow, see https://tchek.gitbook.io/documentation/sdk/web-widget/configuration.

To create a self inspection SSO token via our Token Manager API, keep reading :)

Creating the Self Inspection SSO Token

Here’s the template of the cURL to create a self inspection SSO Token. We’ll explain more in detail the purpose of each object and properties.

Please ensure you enter the API token you are provided by your account manager when creating your account

curl --location --request POST 'https://alto.tchek.fr/apiV1/tokenmanager/token' \
--header 'X-API-Key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
   "options":{
      "shootInspect":true,
      "fastTrack":false,
      "cost":false,
      "report":false,
      "downloadRoi":false
   },
   "tradeIn":{
      "tradeinVehicle":true,
      "immat":"AB123CD",
      "vin":"ABCDEFG1234567890",
      "sendingType":0
   },
   "customer":{
      "clientType":"customer",
      "email":"xx@xxx.com",
      "firstname":"xxxxx",
      "lastname":"xxxxx",
      "gender": null,
      "phone":"0033600000000",
      "locale":"fr"
   },
   "creatorUserId": null,
   "validity":90
}'

This is an example of the response for future reference: 

{
    "token": {
        "expired": false,
        "id": "nFhCfsiXXX",
        "createdAt": "2023-11-17T07:38:53.784Z",
        "updatedAt": "2023-11-17T07:38:53.784Z",
        "tradeinVehicle": true,
        "tradeinStatus": 0,
        "tradeinStatusUpdatedAt": "2023-11-17T07:38:52.376Z",
        "sendingType": 0,
        "vehiclePtr": {
            "id": "2StYBQcBXX"
        },
        "uid": "T9641XX",
        "expiresIn": "2023-12-17T07:38:52.376Z",
        "options": {
            "fastTrack": false,
            "shootInspect": true,
            "cost": false,
            "report": false,
            "downloadRoi": false,
            "loadTchek": true
        },
        "APITokenPtr": {
            "id": "lMIgFNyXXX"
        }
    },
    "webApiVersion": "v2.5"
}

tradeIn

The tradeIn object specifies that this token is allowing the end user to proceed to a self-inspection. Please ensure that "tradeinVehicle" is set to true for a correct functioning. Here you can also add information on your vehicle (license plate (immat) and/or VIN), and whether a message should be sent to the final user upon creating the token (sendingType):

Field
Type
Example
Description

options.shootInspect

boolean

true

Whether the customer must take the pictures themselves

options.fastTrack

boolean

false

Setting fastTrack to true or false in the options object will define whether the final user must do the damage validation after taking the pictures (true), or if the damages are reviewed by your team or by Tchek (false).

options.cost

boolean

false

Must always be false for self-inspection tokens

options.report

boolean

false

Must always be false for self-inspection tokens

options.downloadRoi

boolean

false

Must always be false for self-inspections

tradeIn.tradeinVehicle

boolean

true

Must be true (required)

tradeIn.immat

string

"AB123CD"

(Optional) The vehicle's License plate number

tradeIn.vin

string

"ABCDEFG1234567890"

(Optional) The vehicle's 17-character Vehicle Identification Number

tradeIn.sendingType

number

0

Required, defines if and how a message is sent (see reference below)

customer.clientType

string

"customer"

Required; must be "customer"

customer.email

string

"user@example.com"

Required; customer’s email. See reference below

customer.firstname

string

"John"

Required; customer’s first name. See reference below

customer.lastname

string

"Doe"

Required; customer’s last name. See reference below

customer.gender

string

"men"

Optional; "men", "women", or null

customer.phone

string

"0033612345678"

Required; must include country code. See reference below

customer.locale

string

"fr"

Required; customer language code. Available languages: - en,for English, - fr,for French, - defor German, - nl-BE for Dutch, - itfor Italian, - esfor Spanish, - svfor Swedish, - nofor Norwegian.

creatorUserId

string

""

Optional; ID of the back-office user who created the lead

validity

number

90

Required; number of days before the token expires

sendingType

Value

Description

0

Send token to the customer by email

1

Send token to the customer by SMS

2

Send token to the customer by both SMS & email

null

Create the token without sending a message

Please consider that we’ll need to set up any message templates during your onboarding for you before option 0, 1 and 2 can work.

Directing your customer to the inspection

Upon creating the self inspection SSO token, you can directly redirect the user to the Shoot inspect widget to start the photo shooting by generating yourself the URL to the inspection, such as: https://webapp.tchek.fr/fr/services/[token uid]

Where:

  • The environment can be either https://webapp.tchek.fr (if you created the token by calling the Production environment API URL) or https://preprod.webapp.tchek.fr (for Pre-Production environment). See this article: https://tchek.gitbook.io/documentation/environments

  • The language of the interface can be English (en), French (fr), German (de), Dutch (nl-E), Spanish (es), Italian (it), Swedish (sv) or Norwegian (no) and should match the language of the client

  • The token uid is the unique ID received upon the creation of the self inspection token.

customer

The customer object provides information on the person that will perform the Self inspection. Actual customer information is only required if you:

  • wish us to send them emails or SMS automatically for different events during their inspection;

  • if you want to monitor the inspection progress via our Hub;

  • and if you want their information to be retrieved in the final inspection report.

Otherwise, you MUST fill the fields with placeholders, like so:

"customer": {
        "clientType": customer,
        "email": xx@xx.com,
        "firstname": XXX,
        "gender": null,
        "lastname": XXX,
        "phone": 0033600000000,
        "locale": "en"
    }

locale

The locale is the language of the customer.

Available languages: en for English, fr for French, de for German, nl-BE for Dutch, it for Italian, es for Spanish, sv for Swedish, no for Norwegian. The WebApp interface will be localized according to this parameter.

Changing the locale in the URL while on the self inspection will display the interface in the relevant language.

Setting up your customer inspection

The flow your customer will go through can be largely customized both in terms of look&feel (onboarding and onboarding screens, masks color) or in the level of information to be provided (number of pictures, additional questions). We will help setting up your customized flow when signing up.

See White Label Customizations

Analyzing the damage detection

Once the inspection is complete, ALTO AI automatically detects the damages found in the images. As we mentioned above in the Options section, the way you set your token defines who is in charge of this action. If you set the fastTrack option to true, your end user will land on the Fast Track widget a few seconds after completing the shoot inspect flow. They will be able to dismiss or validate any damages, and to add new ones manually before confirming the report creation.

If you prefer the damages to be reviewed by one of your agents, or if you want Tchek to offer this service as an option, set the fastTrack option to false.

Damages can be reviewed from Tchek’s hub, and can be validated or dismissed from the Fast Track screen, or by choosing Review Damages on the Actions menu in the inspection report.

There’s plenty of ways to create a successful inspection experience!

PreviousUser Flow - integration with your toolsNextWhite Label Customizations

Last updated

Was this helpful?