Skip to content

AuthenticationTrialItem

It is possible to retrieve and filter from the Reach platform all authentication trials generated by your Authentix Configurations.

A authentication trial, instantiated through the AuthenticationTrialItem object, represents a correspondence with the end user that contains a authentication code. It is important to notice that a single authentication can lead to more than one authentication trials.

You can get the statistics of the authentication trial via the AuthenticationTrialStatItem object.

You should also keep in mind that the retrieval of authentication trials is constrained by a built-in rate-limit. You will start getting HTTP 429 "Too Many Requests" responses if you reach that limit.

AuthenticationTrialItem Attributes

  • appletIdstring

    The identifier of the applet.

  • apiVersionstring

    The API version.

  • configurationIdstring

    The identifier of the configuration.

  • authenticationIdstring

    The identifier of the authentication.

  • trialIdstring

    The identifier of the authentication trial.

  • trialStatusstring

    The status of the authentication trial. One of successful, or unsuccessful.

  • channelstring

    The channel used. One of sms, or email.

  • 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.

  • dateCreateddate-time

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

  • dateUpdateddate-time

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

  • pricenumber

    The cost billed for the authentication trial, in the currency specified by priceUnit. This cost does not include the cost for checking the correctness of a code provided by your customer.

  • priceUnitstring

    The currency, in ISO 4127 format, in which price is measured. for example, usd, xaf, eur, cad.

  • channelInfoobject

    channel specific information related to a trial. It is a dictionnary that can contains various type of data depending on the channel being used.

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.