Class LocationVerificationInsights

Namespace

Vonage.IdentityInsights.GetInsights

Assembly

Vonage.dll

Verifies whether the location of a user device is within the area specified in the request.

public record LocationVerificationInsights : IEquatable<LocationVerificationInsights>

Inheritance

object

LocationVerificationInsights

Implements

IEquatable<LocationVerificationInsights>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

LocationVerificationInsights(string, DateTimeOffset, int?, InsightStatus)

Verifies whether the location of a user device is within the area specified in the request.

public LocationVerificationInsights(string IsVerified, DateTimeOffset LatestLocationAt, int? MatchRate, InsightStatus Status)

Parameters

IsVerified string

Result of the verification request:

• TRUE: the network locates the device within the requested area.
• FALSE: the requested area does not match where the network locates the device.
• UNKNOWN: the network cannot locate the device.
• PARTIAL: the requested area partially matches where the network locates the device; a MatchRate may be included.

This enum is extensible; clients must handle unknown values.

LatestLocationAt DateTimeOffset

Date and time in UTC ISO 8601 of the last known location.

MatchRate int?

Estimation of the match rate between the requested area (R) and the area where the network locates the device (N), expressed as a percentage: (R ∩ N) / N × 100. Included only when IsVerified is PARTIAL. Value is between 1 and 99.

Status InsightStatus

Indicates the status of the information returned for the specified phone number.

Properties

IsVerified

Result of the verification request:

• TRUE: the network locates the device within the requested area.
• FALSE: the requested area does not match where the network locates the device.
• UNKNOWN: the network cannot locate the device.
• PARTIAL: the requested area partially matches where the network locates the device; a MatchRate may be included.

This enum is extensible; clients must handle unknown values.

[JsonPropertyName("is_verified")]
public string IsVerified { get; init; }

Property Value

string

LatestLocationAt

Date and time in UTC ISO 8601 of the last known location.

[JsonPropertyName("latest_location_at")]
public DateTimeOffset LatestLocationAt { get; init; }

Property Value

DateTimeOffset

MatchRate

Estimation of the match rate between the requested area (R) and the area where the network locates the device (N), expressed as a percentage: (R ∩ N) / N × 100. Included only when IsVerified is PARTIAL. Value is between 1 and 99.

[JsonPropertyName("match_rate")]
public int? MatchRate { get; init; }

Property Value

int?

Status

Indicates the status of the information returned for the specified phone number.

[JsonPropertyName("status")]
public InsightStatus Status { get; init; }

Property Value

InsightStatus