EnablePin

Description

Set to enable PIN of the type chosen. The PIN should have been disable or it doesn't exists. Is the last case, a new PIN will be created.

The PIN sent in request should be valid by the follow regular expression: "^[0-9]{4,4}$".

The user should be logged to use this method.

Parameters

• token (String, required)

A valid token for identifying the API session context. The token can be anonymous or logged.

• pinType (UserPinType, required)

Define the type of pin.

• pin (string, required)

The value of pin

Returns

Returns a JSON object containing true for successful.

Example:

{

"StatusCode": 0,

"Severity": 1,

"StatusMessage": "OK",

"Content": true

}

Exceptions

• AuthenticationRequiredException
• InvalidPinTypeException
• InvalidCharPinException
• UserPinIsAlreadyEnabledException

Caching

This method is not cached.

Known issues

• None

Version history

API Version Number	Change description	Changes author
1.0	Initial method design	Harley Cabral