VerificationResource
An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- Name
attempts- Type
number | null- Description
The number of attempts made.
- Name
channel?- Type
PhoneCodeChannel- Description
(Optional) The channel used for delivery of phone code verification, if applicable. For example,
'sms'or'whatsapp'.
- Name
error- Type
ClerkAPIError | null- Description
The most recent error encountered during verification.
- 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
A unique nonce associated with the verification.
- Name
message- Type
string | null- Description
A human-readable message about the verification attempt or its status, if available.
- 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.failed: The verification has failed.expired: The verification has expired.
- Name
strategy- Type
string | null- Description
The strategy used for verification.
- Name
verifiedAtClient- Type
string | null- Description
The client ID where the verification was completed.
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