Verification
An interface that represents the state of the verification process of a sign-in or sign-up attempt.
- Name
attempts- Type
number | null- Description
The number of attempts related to the verification.
- Name
error- Type
ClerkAPIError | null- Description
The last error the verification attempt ran into.
- Name
expireAt- Type
Date | null- Description
The time the verification will expire at.
- Name
externalVerificationRedirectURL- Type
URL | null- Description
The redirect URL for an external verification.
- Name
nonce- Type
string | null- Description
The nonce pertaining to the verification.
- Name
status- Type
'unverified' | 'verified' | 'transferable' | 'failed' | 'expired' | null- Description
The state of the verification.
unverified: The verification has not been verified yet.verified: The verification has been verified.transferable: The verification is transferable to between sign-in and sign-up flows. This status is to be used in OAuth and SAML authentication flows.failed: The verification has failed.expired: The verification has expired.
- Name
strategy- Type
string | null- Description
The strategy pertaining to the parent sign-up or sign-in attempt.
Methods
verifiedFromTheSameClient()
A check to see if the verification was verified from the same client as the parent sign-in or sign-up attempt. For example, checking if the verification was verified from the same browser as the parent sign-in or sign-up attempt.
function verifiedFromTheSameClient(): booleanFeedback
Last updated on