Interface IBuilderForOptional
- Namespace
- Vonage.IdentityInsights.GetInsights
- Assembly
- Vonage.dll
public interface IBuilderForOptional : IVonageRequestBuilder<GetInsightsRequest>
- Inherited Members
Methods
WithCurrentCarrier()
Includes current carrier information in the response. Returns the carrier that currently owns the phone number.
IBuilderForOptional WithCurrentCarrier()
Returns
Examples
.WithCurrentCarrier()
WithFormat()
Includes phone number format validation in the response. Returns details such as international and national formats.
IBuilderForOptional WithFormat()
Returns
Examples
.WithFormat()
WithOriginalCarrier()
Includes original carrier information in the response. Returns the carrier that originally owned the phone number.
IBuilderForOptional WithOriginalCarrier()
Returns
Examples
.WithOriginalCarrier()
WithPurpose(string)
Sets the purpose/reason for the request. Required only for Insights that use the Network Registry. For Production Network Registry, the value must match one of the network profile purposes associated with your application. For Playground Network Registry, the value must be "FraudPreventionAndDetection".
IBuilderForOptional WithPurpose(string value)
Parameters
valuestring
Returns
Examples
.WithPurpose("FraudPreventionAndDetection")
WithSimSwap(SimSwapRequest)
Includes SIM swap detection in the response. Use this to detect if the SIM card has been changed recently.
IBuilderForOptional WithSimSwap(SimSwapRequest value)
Parameters
valueSimSwapRequest
Returns
Examples
.WithSimSwap(new SimSwapRequest(Period: 24))