Struct VerifyCodeRequest

Namespace

Vonage.VerifyV2.VerifyCode

Assembly

Vonage.dll

Represents a request to verify a PIN code submitted by a user against an active verification request. The code can be retried up to 3 times before the request is locked.

[Builder(new string[] { })]
public readonly struct VerifyCodeRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Code

Sets the PIN code provided by the user. Must be 4-10 alphanumeric characters matching the code sent to the user.

[Mandatory(1)]
public string Code { get; }

Property Value

string

Examples

.WithCode("1234")

RequestId

Sets the unique identifier (UUID) of the verification request to validate against.

[JsonIgnore]
[Mandatory(0)]
public Guid RequestId { get; }

Property Value

Guid

Examples

.WithRequestId(Guid.Parse("c11236f4-00bf-4b89-84ba-88b25df97315"))

Methods

Build()

public static IBuilderForRequestId Build()

Returns

IBuilderForRequestId

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.