Guide for Stellantis brands

Available data points

You can find a breakdown of all available data points in the Auto API availability for Alfa Romeo, Fiat, Peugeot, Citroën, DS Automobiles, Jeep, Opel and Vauxhall table.

Eligible Models

The following European-market models can have factory-fitted telematics hardware and are generally eligible since 2020-2021. Depending on the model and equipment, vehicles produced several years earlier might also be eligible and we offer an eligibility check based on the vehicle VIN.

Supported Markets

3rd parties and fleet operators in the European Economic Area can gain access to vehicle data.

API Refresh Rate

All vehicles provide data both at the start and end of a journey, as well as during a trip. The update rate depends on the specific data point and the frequency that it is changed, with frequent updates every minute.

API Pricing

For example pricing, please visit our pricing page. You are presented with the final pricing within the platform when creating a production app.

Data Points

You can find a breakdown of all available data points in the following table: Auto API availability for Alfa Romeo, Fiat, Peugeot, Citroën, DS Automobiles, Jeep, Opel and Vauxhall. Each request returns data points and corresponding timestamps; the timestamps indicate the moment the data was transferred from the vehicle.

Webhooks

The webhooks below are currently in production.

Example webhook

The following example shows the JSON content of an vehicle_location_changed event being delivered.

{
    "vehicle": {
        "vin": "1HMCF6112HA3FBBCC",
        "serial_number": "BB5EAC44D33F205A87"
    },
    "event": {
        "type": "vehicle_location_changed",
        "received_at": "2019-02-20T09:13:33.563772Z",
        "action": null
    },
    "application": {
        "id": "A77294AC8DA324FB46DA98921"
    }
}

Consent flow

Important

The consent flow only applies to services for individual car owners. If your are a fleet customer, please refer to the Fleet Clearance guide to see how vehicle activation works.

The vehicle owner has to go through the following steps in order to grant access to their Stellantis group brand vehicle data. To support the process, we offer a consumer-oriented service called Driver by High Mobility to vehicle owners. Through a Driver account, it's possible to manage 3rd party data access to all vehicles and to monitor and revoke access at any time by visiting the Driver Dashboard. The consent flow works in every browser and in addition we offer SDKs for iOS and Android to easily include it in any native mobile application.

Click on any image to see a full-sized graphic.

OAuth2

The technical integration of the consent flow is done according to the OAuth 2.0 User Consent guide.

Step 1 | Landing screen

As soon as you trigger the consent flow, the following screen is shown to the user. If the user already has a Driver account they can use it to sign in and select one of their previously used vehicles. In this flow we assume it's a first-time user.

The logo on the top left of the view and the name "Service X" is replaced with the details that you enter for your production application in the console.

Language parameter

It's possible to set the language for the consent flow by passing in the locale parameter when initiating the consent flow. English and German are currently supported.

Step 2 | Account Creation

The user is prompted to create an account by entering their email and selecting their country. Once the consent flow has finished, we send a confirmation email to the user with a link to set their password. The terms of use and privacy policy informs the user about our data handling which is fully GDPR compliant.

Legal transparency

You can read the Terms of Use and Privacy Policy of the Driver account on our website.

Step 3 | Car Brand Selection

In this step we ask the user to select their vehicle brand. Every manufacturer that has been activated for your production application is listed in this screen and the user can select which car they want to connect.

Brand parameter

It's possible to skip this step by passing in the brand as a parameter when initiating the consent flow according to the OAuth 2.0 User Consent guide.

Step 4 | User Verification

Once a Stellantis group brand has been selected we ask the user to perform an identity verification. The identification process is processed by Electronic IDentification and is fully compliant with all relevant regulations. This step is only required to be done once and does not have to be repeated the next time this user wants to connect a Stellantis vehicle.

Step 5 | VIN Entry

Once the user verification has been completed, we ask the user to enter the Vehicle Identification Number (VIN) of their vehicle. In case the vehicle has been added earlier by the user, the VIN has been stored and can be selected directly from a list.

The user can find their VIN from several places. If a myPeugeot, myOpel or a similar application has been installed by the user, they can open it up to see the VIN of their connected car. Another alternative is to look at the vehicle windscreen or other vehicle documents that include the VIN.

Step 6 | Permissions Consent

The most important step is the approval by the user that your service may get access to their vehicle data. The data points that are listed here are taken from the granted rights for your production application.

Once we have established user consent to share data with your service, there is a redirect back to your service using the redirect_uri that was used for the initiation of the consent flow. Note that only Redirect URIs that have been registered for your production application in the console are allowed.

In the background we trigger a request to activate the vehicle connection, which is a process that can take several days and requires the vehicle to be driven to generate new data. The user will receive an email together with a link to finalise the data sharing to your service as soon as the vehicle is technically online.

Pending access token

Note that as the activation is still in progress at this stage, the OAuth2 access token status is set to pending when the redirect back to your service is done.

Step 7 | Mileage Verification

Once the activation of the vehicle data access has succeeded, we send an email to the user with a link to enter the current mileage reading.

By having verified the vehicle possession of the user, the status of the OAuth2 access token that was granted in step 6 is changed to approved and it's possible to use any of our APIs or SDKs to start fetching data for this specific vehicle. We will send out an email every 3 months to the user to verify their mileage reading in order to keep the data connection to your service.

Authorisation webhook

To get notified when the user has completed the final step, you can subscribe to the authorization_changed webhook.

More Information

Should you have any questions, please book an appointment or contact us on our Slack channel.