Class StartVerificationResponse

Namespace

Vonage.VerifyV2.StartVerification

Assembly

Vonage.dll

Represents the response from starting a verification request, containing the request identifier and optional Silent Auth check URL.

public record StartVerificationResponse : IEquatable<StartVerificationResponse>

Inheritance

object

StartVerificationResponse

Implements

IEquatable<StartVerificationResponse>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

StartVerificationResponse(Guid, Maybe<Uri>)

Represents the response from starting a verification request, containing the request identifier and optional Silent Auth check URL.

public StartVerificationResponse(Guid RequestId, Maybe<Uri> CheckUrl)

Parameters

RequestId Guid

The unique identifier (UUID) of the verification request. Use this ID for subsequent operations like VerifyCodeAsync(Result<VerifyCodeRequest>) or CancelAsync(Result<CancelRequest>).

CheckUrl Maybe<Uri>

The URL for Silent Authentication completion. Only returned when the first workflow is Silent Auth and the network supports it. The user's device must access this URL via cellular data to complete verification.

Properties

CheckUrl

The URL for Silent Authentication completion. Only returned when the first workflow is Silent Auth and the network supports it. The user's device must access this URL via cellular data to complete verification.

[JsonPropertyOrder(1)]
[JsonConverter(typeof(MaybeJsonConverter<Uri>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<Uri> CheckUrl { get; init; }

Property Value

Maybe<Uri>

RequestId

The unique identifier (UUID) of the verification request. Use this ID for subsequent operations like VerifyCodeAsync(Result<VerifyCodeRequest>) or CancelAsync(Result<CancelRequest>).

[JsonPropertyOrder(0)]
public Guid RequestId { get; init; }

Property Value

Guid

Methods

BuildVerificationRequest(string)

Creates a VerifyCodeRequest to validate the PIN code entered by the user.

public Result<VerifyCodeRequest> BuildVerificationRequest(string verificationCode)

Parameters

verificationCode string

The PIN code provided by the user.

Returns

Result<VerifyCodeRequest>

A VerifyCodeRequest ready to submit to VerifyCodeAsync(Result<VerifyCodeRequest>).