Class Insights

Namespace

Vonage.IdentityInsights.GetInsights

Assembly

Vonage.dll

A map of objects representing the requested insight(s), where each key corresponds to the name of the insight and the value contains the result and status of that insight.

public record Insights : IEquatable<Insights>

Inheritance

object

Insights

Implements

IEquatable<Insights>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Insights(FormatInsights, SimSwapInsights, CarrierInsights, CarrierInsights, LocationVerificationInsights, SubscriberMatchInsights, RoamingInsights, ReachabilityInsights, DeviceSwapInsights)

A map of objects representing the requested insight(s), where each key corresponds to the name of the insight and the value contains the result and status of that insight.

public Insights(FormatInsights Format, SimSwapInsights SimSwap, CarrierInsights OriginalCarrier, CarrierInsights CurrentCarrier, LocationVerificationInsights LocationVerification = null, SubscriberMatchInsights SubscriberMatch = null, RoamingInsights Roaming = null, ReachabilityInsights Reachability = null, DeviceSwapInsights DeviceSwap = null)

Parameters

Format FormatInsights

Validates the format of a phone number and provides information based on that format.

SimSwap SimSwapInsights

Information about any recent SIM pairing changes related to a mobile account. A recent SIM swap may indicate a potential risk of account takeover.

OriginalCarrier CarrierInsights

Information about the network the number was initially assigned. Information based on the numbering plan prefix.

CurrentCarrier CarrierInsights

Information about the network the number is currently assigned. This is applicable to mobile numbers only.

LocationVerification LocationVerificationInsights

Verify whether the location of a user device is within the area specified in the request. Only present when requested.

SubscriberMatch SubscriberMatchInsights

Compare information associated with a mobile phone user against records verified by the mobile operator in their KYC system. Only present when requested.

Roaming RoamingInsights

Check roaming status and country for a given device on a mobile network. Only present when requested.

Reachability ReachabilityInsights

Check the connectivity status for a given device, including whether it is connected to the network for data, SMS, or both. Only present when requested.

DeviceSwap DeviceSwapInsights

Information about any recent physical device change for a mobile phone number. A recent device swap may indicate a potential risk of account takeover. Only present when requested.

Properties

CurrentCarrier

Information about the network the number is currently assigned. This is applicable to mobile numbers only.

[JsonPropertyName("current_carrier")]
public CarrierInsights CurrentCarrier { get; init; }

Property Value

CarrierInsights

DeviceSwap

Information about any recent physical device change for a mobile phone number. A recent device swap may indicate a potential risk of account takeover. Only present when requested.

[JsonPropertyName("device_swap")]
public DeviceSwapInsights DeviceSwap { get; init; }

Property Value

DeviceSwapInsights

Format

Validates the format of a phone number and provides information based on that format.

[JsonPropertyName("format")]
public FormatInsights Format { get; init; }

Property Value

FormatInsights

LocationVerification

Verify whether the location of a user device is within the area specified in the request. Only present when requested.

[JsonPropertyName("location_verification")]
public LocationVerificationInsights LocationVerification { get; init; }

Property Value

LocationVerificationInsights

OriginalCarrier

Information about the network the number was initially assigned. Information based on the numbering plan prefix.

[JsonPropertyName("original_carrier")]
public CarrierInsights OriginalCarrier { get; init; }

Property Value

CarrierInsights

Reachability

Check the connectivity status for a given device, including whether it is connected to the network for data, SMS, or both. Only present when requested.

[JsonPropertyName("reachability")]
public ReachabilityInsights Reachability { get; init; }

Property Value

ReachabilityInsights

Roaming

Check roaming status and country for a given device on a mobile network. Only present when requested.

[JsonPropertyName("roaming")]
public RoamingInsights Roaming { get; init; }

Property Value

RoamingInsights

SimSwap

Information about any recent SIM pairing changes related to a mobile account. A recent SIM swap may indicate a potential risk of account takeover.

[JsonPropertyName("sim_swap")]
public SimSwapInsights SimSwap { get; init; }

Property Value

SimSwapInsights

SubscriberMatch

Compare information associated with a mobile phone user against records verified by the mobile operator in their KYC system. Only present when requested.

[JsonPropertyName("subscriber_match")]
public SubscriberMatchInsights SubscriberMatch { get; init; }

Property Value

SubscriberMatchInsights