To add or update a PIN to a user's profile you should do the following:
You should use:
GET /api/users/{user_id}
To retrieve the current user Information, for example (for user_id=2):
Body response:
Here you can see the selected user does not have a PIN assigned to his profile yet.
Let us go ahead and configure one.
Depending on the language you are working with you should handle the User JSON object and assign the PIN number to the PIN key object.
The object to send within the BODY REQUEST shall look like:
{
"User": {
"pin": my_pin
}
}
Where “my_pin” shall be an integer with up to 16 digits (or the string equivalent to such integer value)
The API Call needed is:
PUT /api/users/{user_id}
Then you would get a response like:
Afterwards you can request the information once again and you should see something like:
In contrast with the first result you can see the encrypted value equivalent to the PIN you previously configured. And the “pin_exists” flag set to true.
IMPORTANT:
For security concerns the “pin” is encrypted, then you will be able to use the previously configured PIN, and in case the user would not remember its previous PIN, one shall configure or set a new PIN.
NOTICE:
A PIN only auth method is not allowed, the least you would need to configure as an auth method will be ID+PIN
If you need further information, please open a ticket in this website and the tech support personnel from your area will be in contact with you as soon as possible.