Skip to content

AuthenticationControlItem

The AuthenticationControlItem object represents a authentication validation process. It allows to validate the correctness of the user-provided code.

As a prerequisite, you must have created a a Authentix configuration and initiate a authentication process.

AuthenticationControlItem 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 outcome of the authentication control. One of failed or passed.

  • deststring

    The phone number or email being verified. Phone numbers must be in E.164 format.

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