Table of Contents

Class SubscriberMatchInsights

Namespace
Vonage.IdentityInsights.GetInsights
Assembly
Vonage.dll

Compares information associated with a mobile phone user against records verified by the mobile operator in their KYC system. All match fields use extensible enum strings; clients must handle unknown values.

public record SubscriberMatchInsights : IEquatable<SubscriberMatchInsights>
Inheritance
SubscriberMatchInsights
Implements
Inherited Members

Constructors

SubscriberMatchInsights(string, string, string, string, string, string, string, string, string, string, string, string, InsightStatus)

Compares information associated with a mobile phone user against records verified by the mobile operator in their KYC system. All match fields use extensible enum strings; clients must handle unknown values.

public SubscriberMatchInsights(string IdDocumentMatch, string GivenNameMatch, string FamilyNameMatch, string AddressMatch, string StreetNameMatch, string StreetNumberMatch, string PostalCodeMatch, string LocalityMatch, string RegionMatch, string CountryMatch, string HouseNumberExtensionMatch, string BirthdateMatch, InsightStatus Status)

Parameters

IdDocumentMatch string

Indicates whether the ID document number of the customer matches the one on the operator's system. Possible values: EXACT, HIGH, PARTIAL, LOW, NONE, DATA_UNAVAILABLE.

GivenNameMatch string

Indicates whether the first/given name of the customer matches the one on the operator's system.

FamilyNameMatch string

Indicates whether the last/family name of the customer matches the one on the operator's system.

AddressMatch string

Indicates whether the complete address of the customer matches the one on the operator's system.

StreetNameMatch string

Indicates whether the street name of the customer matches the one on the operator's system. Possible values: EXACT, HIGH, PARTIAL, LOW, NONE, DATA_UNAVAILABLE, INCLUDED_WITH_ADDRESS_MATCH.

StreetNumberMatch string

Indicates whether the street number of the customer matches the one on the operator's system.

PostalCodeMatch string

Indicates whether the postal/zip code of the customer matches the one on the operator's system.

LocalityMatch string

Indicates whether the locality of the customer's address matches the one on the operator's system.

RegionMatch string

Indicates whether the region or prefecture of the customer matches the one on the operator's system.

CountryMatch string

Indicates whether the country of the customer's address matches the one on the operator's system.

HouseNumberExtensionMatch string

Indicates whether the house number extension of the customer's address matches the one on the operator's system.

BirthdateMatch string

Indicates whether the birthdate of the customer matches the one on the operator's system.

Status InsightStatus

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

Properties

AddressMatch

Indicates whether the complete address of the customer matches the one on the operator's system.

[JsonPropertyName("address_match")]
public string AddressMatch { get; init; }

Property Value

string

BirthdateMatch

Indicates whether the birthdate of the customer matches the one on the operator's system.

[JsonPropertyName("birthdate_match")]
public string BirthdateMatch { get; init; }

Property Value

string

CountryMatch

Indicates whether the country of the customer's address matches the one on the operator's system.

[JsonPropertyName("country_match")]
public string CountryMatch { get; init; }

Property Value

string

FamilyNameMatch

Indicates whether the last/family name of the customer matches the one on the operator's system.

[JsonPropertyName("family_name_match")]
public string FamilyNameMatch { get; init; }

Property Value

string

GivenNameMatch

Indicates whether the first/given name of the customer matches the one on the operator's system.

[JsonPropertyName("given_name_match")]
public string GivenNameMatch { get; init; }

Property Value

string

HouseNumberExtensionMatch

Indicates whether the house number extension of the customer's address matches the one on the operator's system.

[JsonPropertyName("house_number_extension_match")]
public string HouseNumberExtensionMatch { get; init; }

Property Value

string

IdDocumentMatch

Indicates whether the ID document number of the customer matches the one on the operator's system. Possible values: EXACT, HIGH, PARTIAL, LOW, NONE, DATA_UNAVAILABLE.

[JsonPropertyName("id_document_match")]
public string IdDocumentMatch { get; init; }

Property Value

string

LocalityMatch

Indicates whether the locality of the customer's address matches the one on the operator's system.

[JsonPropertyName("locality_match")]
public string LocalityMatch { get; init; }

Property Value

string

PostalCodeMatch

Indicates whether the postal/zip code of the customer matches the one on the operator's system.

[JsonPropertyName("postal_code_match")]
public string PostalCodeMatch { get; init; }

Property Value

string

RegionMatch

Indicates whether the region or prefecture of the customer matches the one on the operator's system.

[JsonPropertyName("region_match")]
public string RegionMatch { get; init; }

Property Value

string

Status

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

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

Property Value

InsightStatus

StreetNameMatch

Indicates whether the street name of the customer matches the one on the operator's system. Possible values: EXACT, HIGH, PARTIAL, LOW, NONE, DATA_UNAVAILABLE, INCLUDED_WITH_ADDRESS_MATCH.

[JsonPropertyName("street_name_match")]
public string StreetNameMatch { get; init; }

Property Value

string

StreetNumberMatch

Indicates whether the street number of the customer matches the one on the operator's system.

[JsonPropertyName("street_number_match")]
public string StreetNumberMatch { get; init; }

Property Value

string
Edit this page