Skip to content

AuthenticationItem

The Reach Authentix API allows you to authenticate users using one time tokens. The API lets you inititate a new authentication process for a user and then control that the authentication was successful. This is done using the AuthenticationItem object.

Note that before you are able to inititate a authentication process, you must have created, as a prerequisite, a Authentix configuration.

AuthenticationItem Attributes

  • appletIdstring

    The identifier of the applet.

  • apiVersionstring

    The API version.

  • configurationIdstring

    The identifier of the configuration.

  • authenticationIdstring

    The identifier of the authentication.

  • statusstring

    The status of the authentication. One of awaiting, passed, expired, or canceled.

  • deststring

    The destination of the authentication code. Phone numbers are in E.164 format.

  • channelstring

    The channel used. One of sms, or email.

  • expiryTimeinteger

    An expiry time in minutes.

  • maxTrialsinteger

    The maximum number of authentication trials.

  • maxControlsinteger

    The maximum number of authentication controls.

  • paymentInfoobject

    Information related to the digital payment to authenticate. It is required when usedForDigitalPayment is true. It is ignored otherwise. See the PaymentInfo section for a description of this object.

  • trialsarray

    An array of authentication trials containing channel-specific information about each trial. Refer to TrialQuickInfo section for a type description of the elements.

  • dateCreateddate-time

    The date and time in UTC that the authentication was created.

  • dateUpdateddate-time

    The date and time in UTC that the authentication was last updated.

PaymentInfo Data

The paymentInfo data encapsulates the information associated with a digital payment transaction to be authenticate. It is made of the following properties:

  • payeestring

    The payee of the financial transaction.

  • amountnumber

    The amount of the transaction.

  • currencystring

    The currency used in the transaction.

TrialQuickInfo Data

This object represents a quick overview of an authentication trial and it is characterized by the following properties:

  • trialIdstring

    the trial ID.

  • channelstring

    The channel used (sms, email).

  • dateCreateddate-time

    The date and time in UTC that the trial was created.