Lock Status

Returns the lock status for a vehicle and the open status of its doors, windows, storage units, sunroof and charging port where available.

cURL

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

Example Response

{
	"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" } 
	]
}

The Vehicles API v2.0 will be deprecated by Q4 of 2026. We recommend migrating to the latest version as soon as possible to ensure continued support and access to new features.

Permission

read_security

Request

Path

id · string · required

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

cURL

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

Response

isLocked · boolean

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.

Show doors

type · string

The location of the door.

status · string

Indicates the current state of the vehicle’s door. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

windows · [object]

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

Show windows

type · string

The location of the window.

status · string

Indicates the current state of the vehicle’s window. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

sunroof · [object]

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

Show sunroofs

type · string

The location of the sunroof.

status · string

Indicates the current state of the vehicle’s sunroof. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

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.

Show storage

type · string

The location of the storage.

status · string

Indicates the current state of the vehicle’s storage. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

chargingPort · [object]

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

Show chargingPort

type · string

The location of the charging port.

status · string

Indicates the current state of the vehicle’s charging port. UNKNOWN indicates the vehicle supports this status, but did not provide a valid status for the request

Example Response

{
	"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.