Module dev.eidentification.bankid
Package dev.eidentification.bankid.client.model.enums

Enum Class HintCode

java.lang.Object
java.lang.Enum<HintCode>
dev.eidentification.bankid.client.model.enums.HintCode
All Implemented Interfaces:
Serializable, Comparable<HintCode>, Constable
public enum HintCode extends Enum<HintCode>
Enumeration for representing various hint codes that might be encountered from the BankID API.

  • Enum Constant Details

    • OUTSTANDING_TRANSACTION

      public static final HintCode OUTSTANDING_TRANSACTION
      Order is pending. The BankID app has not yet received the order. The hintCode will later change to noClient, started or userSign.

    • NO_CLIENT

      public static final HintCode NO_CLIENT
      Order is pending. The client has not yet received the order.

    • STARTED

      public static final HintCode STARTED
      Order is pending. A BankID client has launched with autostarttoken but a usable ID has not yet been found in the client.

      When the client launches there may be a short delay until all IDs are registered.

      The user may not have any usable IDs, or is yet to insert their smart card.

    • USER_MRTD

      public static final HintCode USER_MRTD
      Order is pending. A client has launched and received the order but additional steps for providing MRTD information is required to proceed with the order.

    • USER_CALL_CONFIRM

      public static final HintCode USER_CALL_CONFIRM
      Order is waiting for the user to confirm that they have received this order while in a call with the RP.

    • USER_SIGN

      public static final HintCode USER_SIGN
      Order is pending. The BankID client has received the order.

    • EXPIRED_TRANSACTION

      public static final HintCode EXPIRED_TRANSACTION
      The order has expired. The BankID security app/program did not launch, the user did not finalize the signing or the RP called collect too late.

    • CERTIFICATE_ERROR

      public static final HintCode CERTIFICATE_ERROR
      This error is returned if:

      The user has entered the wrong PIN code too many times. The BankID cannot be used. The user’s BankID is blocked. The user’s BankID is invalid.

    • USER_CANCEL

      public static final HintCode USER_CANCEL
      The order was cancelled by the user. userCancel may also be returned in some rare cases related to other user interactions.

    • CANCELLED

      public static final HintCode CANCELLED
      The order was cancelled. The system received a new order for the user.

    • START_FAILED

      public static final HintCode START_FAILED
      The user did not provide their ID or the client did not launch within a certain time limit. Potential causes are:

      RP did not use autoStartToken when launching the BankID security app. RP must correct this in their implementation. Client software was not installed or other problem with the user’s device.

    • USER_DECLINED_CALL

      public static final HintCode USER_DECLINED_CALL
      The order was cancelled because the user indicated in the app that they are not in a call with the RP about the order.

    • UNKNOWN

      public static final HintCode UNKNOWN
      New hint code may be introduced without prior notice.

  • Method Details

    • values

      public static HintCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static HintCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • of

      public static HintCode of(String code)

    • getCode

      public String getCode()