GET
/
vehicles
/
{id}
/
security
curl "https://api.smartcar.com/v2.0/vehicles/{id}/security" \
    -H "Authorization: Bearer {token}" \
    -X "GET"

{
	"isLocked" : false,
	"doors" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "OPEN"},
		{"type": "backRight" , "status" : "CLOSED"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"windows" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "CLOSED"},
		{"type": "backRight" , "status" : "UNKNOWN"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"sunroof" : [
		{"type": "sunroof" , "status" : "CLOSED"}
	], 	
	"storage" : [
		{"type": "rear" , "status" : "UNKNOWN"},
		{"type": "front" , "status" : "CLOSED"}
	],
	"chargingPort" : [ 
		{"type" : "chargingPort", "status" : "CLOSED" } 
	]
}

​
Permission

read_security

​
Request

Path

​
id
string
required

The vehicle ID of the vehicle you are making a request to.

curl "https://api.smartcar.com/v2.0/vehicles/{id}/security" \
    -H "Authorization: Bearer {token}" \
    -X "GET"

​
Response

​
isLocked
bool

Indicates the current lock status of the vehicle as reported by the OEM.

​
doors
[object]

An array of the open status of the vehicle’s doors.

​
windows
[object]

An array of the open status of the vehicle’s windows.

​
sunroof
[object]

An array of the open status of the vehicle’s sunroofs.

​
storage
[object]

An array of the open status of the vehicle’s storages. For internal combustion and plug-in hybrid vehicles front refers to the engine hood. For battery vehicles, this will be the front trunk.

​
chargingPort
[object]

An array of the open status of the vehicle’s charging port.

{
	"isLocked" : false,
	"doors" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "OPEN"},
		{"type": "backRight" , "status" : "CLOSED"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"windows" : [
		{"type": "frontLeft" , "status" : "CLOSED"},
		{"type": "frontRight" , "status" : "CLOSED"},
		{"type": "backRight" , "status" : "UNKNOWN"},
		{"type": "backLeft" , "status" : "CLOSED"}
	],
	"sunroof" : [
		{"type": "sunroof" , "status" : "CLOSED"}
	], 	
	"storage" : [
		{"type": "rear" , "status" : "UNKNOWN"},
		{"type": "front" , "status" : "CLOSED"}
	],
	"chargingPort" : [ 
		{"type" : "chargingPort", "status" : "CLOSED" } 
	]
}

​
Notes

  • The open status array(s) will be empty if a vehicle has partial support.
  • The request will error if lockStatus can not be retrieved from the vehicle or the brand is not supported.

Was this page helpful?