Struct FraudCheckRequest

Namespace

Vonage.NumberInsightV2.FraudCheck

Assembly

Vonage.dll

Represents a request to perform fraud detection checks on a phone number using the Number Insight V2 API.

public readonly struct FraudCheckRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

Insights

The insight types requested for this fraud check. Available values: "fraud_score" (deprecated) and "sim_swap". At least one insight type must be specified.

[JsonPropertyOrder(2)]
public IEnumerable<string> Insights { get; }

Property Value

IEnumerable<string>

Phone

The phone number to check for fraud risk, in E.164 format without a leading + or 00. Start with the country code, e.g., 447700900000.

[JsonPropertyOrder(1)]
[JsonConverter(typeof(PhoneNumberJsonConverter))]
public PhoneNumber Phone { get; }

Property Value

PhoneNumber

Type

The type of identifier being checked. Always "phone" for phone number lookups.

[JsonPropertyOrder(0)]
public string Type { get; }

Property Value

string

Methods

Build()

Creates a builder for constructing a FraudCheckRequest.

public static IBuilderForPhone Build()

Returns

IBuilderForPhone

A builder instance to configure the fraud check request.

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.