Skip to main content

PIN

Composition​

PIN​

A PIN can be used as an additional verification method for child addresses. When performing certain tasks (such as withdrawals) through a child address, if a PIN is set on that child address, the correct PIN must be entered for the task to proceed.

A PIN can be any string, including numbers, and is encrypted and securely stored inside Octet.


Recovery PIN​

It is used to control (change or delete) the PIN of a child address, and must be entered together when creating the PIN. Clients may use the Recovery PIN in various ways, depending on their PIN operation policy.


1. Use as a Master PIN​

When the client enters the Recovery PIN, it can be used as a Master PIN.

In this case, when an end user loses the PIN or requests a change, the client can handle it with the Master PIN, which enables efficient CS handling.


2. Use as a secondary PIN​

When the end user enters the Recovery PIN as well, it can be used as a secondary PIN.

In this case, when end users lose or change their PIN, they must enter the Recovery PIN themselves. No one other than the end user can access the assets arbitrarily. However, if the end user loses the secondary PIN, the existing PIN cannot be changed or deleted.


Using the PIN feature​

Setting up​

You can set a PIN when you call the Create Child Address API to create a child address.

If you want to set a new PIN on a child address that was created without one, you can do so by calling the Create Child Address PIN API.


Deleting​

You can delete a configured PIN by calling the Delete Child Address PIN API. You must enter the correct recovery PIN that controls the PIN.


Changing​

You can change a configured PIN by calling the Update Child Address PIN API. You must enter the correct recovery PIN that controls the PIN.