igloo
Docs / igloohome / Getting Started / What is algoPIN?

What is algoPIN?

algoPIN is a feature that allows you to generate valid PIN codes even when you don't have WiFi, cellular, or remote access to your lock.

Types of algoPIN Codes

  • One-Time (OTP)
  • Permanent
  • Duration (Hourly) — 1 to 672 hours
  • Duration (Daily) — 29 to 367 days

algoPIN Limitations

Limitation Explanation
Only on algoPIN-supported devices The device has to support algoPIN. See Supported Devices.
Paired devices The device has to be paired, and it has to be paired using the igloohome app.
24-hour activation algoPIN codes that last more than 24 hours need to be activated on the lock. To activate it, use the PIN code within the first 24 hours of its validity.
256 rule 256-hour algoPIN deletion limitation. If an algoPIN is created with a start date more than 256 hours from the current time, it can't be deleted.
199 rule The whitelist and blacklist of the lock is 199 PIN codes max (both algoPIN and Bluetooth PIN codes).
Number of PINs per duration For a specified duration, you may only generate a fixed number of PINs, indicated by the number of variances.

Variance: Multiple algoPIN Codes for the Same Duration

For a given duration, you can create multiple unique algoPIN codes.

PIN Code Type Number of Variances
OTP 5
Permanent 5
Duration (Hourly) 3
Duration (Daily) 3

Example: the following request returns a unique PIN code (e.g. 4642226).

curl --request POST \
  --url https://api.igloodeveloper.co/igloohome/devices/IGP101abc123/algopin/onetime \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer abcdef' \
  --data '{
  "variance": 1,
  "startDate": "2022-01-01T00:00:00+08:00",
  "accessName": "Maintenance guy"
}'

Changing the variance returns a second unique PIN code (e.g. 1419472) for the same duration.

curl --request POST \
  --url https://api.igloodeveloper.co/igloohome/devices/IGP101abc123/algopin/onetime \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer abcdef' \
  --data '{
  "variance": 2,
  "startDate": "2022-01-01T00:00:00+08:00",
  "accessName": "Maintenance guy 2"
}'

Activation Limitation

algoPIN codes that last longer than 24 hours require activation on the lock. To activate one, use the algoPIN code on the lock within the 24-hour window.