Inttegro.Otp.Verification (inttegro v0.2.0)

Copy Markdown View Source

Represents Verification data in the Otp API.

Inttegro decodes API responses into this struct. Required fields are always present; optional fields are nil when they do not apply or were not returned. Follow the linked types in t/0 for nested domain values.

Initiates, verifies, and inspects one-time passcode transactions.

OTP delivery and verification are separate steps. Initiation returning successfully means the transaction was accepted, not that the recipient received or verified the code. Keep the returned transaction ID and submit the user-provided code through verify/3.

Summary

Types

t()

The decoded verification value.

Functions

new!(attrs \\ %{})

Builds a Inttegro.Otp.Verification and raises KeyError when a required field is missing.

Types

t()

@type t() :: %Inttegro.Otp.Verification{
  transaction: Inttegro.Otp.Transaction.t(),
  verification_attempt: Inttegro.Otp.VerificationAttempt.t()
}

The decoded verification value.

Functions

new!(attrs \\ %{})

@spec new!(map() | keyword()) :: t()

Builds a Inttegro.Otp.Verification and raises KeyError when a required field is missing.