Skip to main content

Success

user_id
string
A Smartcar-generated UUID that identifies this user. Store this ID alongside your internal user identifier — you will use it as the sc-user-id header when making API requests on behalf of this user.
state
If the redirect to Smartcar Connect contains a state parameter, that parameter will be returned here.
Success
HTTP/1.1 302 Found
Location: https://example.com/home?
user_id=725146a3-69f4-46c8-965d-54b3b6f81eb7
&state=0facda3319

Error

For a detailed description of these errors, please see our errors page.
error
The type of error
error_description
A detailed description of what caused the error
state
If the redirect to Smartcar Connect contains a state parameter, that parameter will be returned here.
Error
HTTP/1.1 302 Found
Location: https://example.com/home?
error=access_denied
&error_description=User+denied+access+to+application.
&state=0facda3319
In addition to the error code and description, Smartcar will return the following parameters when a user tries to authorize an incompatible vehicle in Connect.
vin
Can be returned for errors where the vehicle is incompatible.
make
The manufacturer of the vehicle.
model
The model of the vehicle.
year
The year of production of the vehicle.

What’s Next

Now that you have a user_id, here’s what you can do with it:
  • API Authentication — Get an application access token to make API requests
  • API Overview — See what data and commands you can access
  • Vehicle Data — Read signals like battery level, odometer, and location
  • Vehicle Commands — Lock, unlock, start/stop charging, set destination, and more
  • Connections — List and manage this user’s vehicle connections
Pass the user_id as the sc-user-id header on any request to scope it to this user.