7. OTP entity

When you send an OTP the API will reply with an entity for the specific OTP delivery request.

Parameter

Explanation

Default value

AccountId

Type: “String”

This is your accountId in the tyntec system. You cannot change this value.

Your 2FA accountId

ApplicationId

Type: “UUID”

This is a UUID that identifies the specific application that was used to deliver this OTP.

 

otpId

Type: “UUID”

The unique id that identified this OTP delivery request.

A random UUID created by tyntec

created

Type: “Integer”

The time that this OTP request was created in milliseconds.

now()

expire

Type: “Integer”

The time that this OTP will expire in milliseconds.

Now() + the “expire” attribute of the application

number

Type: “String”

The telephone number that was used as destination for this OTP delivery request. In E164 format.

 

attemptCount

Type: “Integer”

The number of attempts made for this OTP to be validated.

 

 

otpStatus

Type: “String”

The OTP status. Possible values:

 

  • “ACTIVE” – The OTP is still active
  • VERIFIED – The OTP was verified successfully
  • EXPIRED – The OTP expired
  • TOO_MANY_ATTEMPTS – The OTP validation requests exceeded the maximum allowed by the application configuration.

 

timestampCreated

Type: “Timestamp”

The string timestamp “created” representation in UTC Z format

 

timestampExpire

Type: “Timestamp”

The string timestamp “expire” representation in UTC Z format