L'objet AuthenticationItem

L'API Reach Authentix vous permet d'authentifier les utilisateurs à l'aide des tokens à usage unique. L'API vous permet d'initier un nouveau processus d'authentification pour un utilisateur et de contrôler que l'authentification a réussi. Cela se fait à l'aide de l'objet AuthenticationItem.

Notez qu'avant de pouvoir lancer un processus d'authentification, vous devez avoir créé, comme condition préalable, une configuration Authentix.

Attributs de AuthenticationItem

• appletIdstring

  L'identifiant de l'applet.

• apiVersionstring

  La version de l'API.

• configurationIdstring

  L'identifiant de la configuration.

• authenticationIdstring

  L'identifiant de l'authentification.

• statusstring

  Le statut de l'authentification. Au choix entre awaiting, passed, expired, ou canceled.

• deststring

  Le destinataire du token d'authentification. Les numéros de téléphone sont au format E.164.

• channelstring

  Le canal utilisé. Au choix entre sms, ou email.

• expiryTimeinteger

  Un délai d'expiration en minutes.

• maxTrialsinteger

  Le nombre maximum d'essais d'authentification.

• maxControlsinteger

  Le nombre maximum de procédures de validation de code.

• paymentInfoobject

  Informations relatives au paiement numérique à authentifier. Elle est requise lorsque usedForDigitalPayment est vrai. Il est ignoré dans le cas contraire. Voir la section PaymentInfo pour une description de cet objet.

• trialsarray

  Tableau d'essais d'authentification contenant des informations spécifiques à chaque canal. Se référer à la section TrialQuickInfo pour une description de type des éléments.

• dateCreateddate-time

  La date et l'heure (UTC) auxquelles l'authentification a été créé.

• dateUpdateddate-time

  La date et l'heure (UTC) de la dernière mise à jour de l'authentification.

L'objet PaymentInfo

L'objet PaymentInfo encapsule les informations associées à une transaction de paiement numérique à authentifier. Elle est composée des propriétés suivantes :

• payeestring

  Le bénéficiaire de la transaction financière.

• amountnumber

  Le montant de la transaction.

• currencystring

  La devise utilisée dans la transaction.

L'objet TrialQuickInfo

Cet objet représente un aperçu rapide d'un essai d'authentification et est caractérisé par les propriétés suivantes:

• trialIdstring

  l'identifiant de l'essai d'authentification.

• channelstring

  Le canal utilisé (sms, email).

• dateCreateddate-time

  La date et l'heure en UTC auxquelles l'essai d'authentification a été créé.