Sinch .NET SDK for Verification

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

The Sinch .NET SDK allows you to quickly interact with the Verification API from inside your .NET applications. When using the .NET SDK, the code representing requests and queries sent to and responses received from the Verification API are structured similarly to those that are sent and received using the Verification API.

The fastest way to get started with the SDK is to check out our getting started guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK.

Syntax

When using the .NET SDK, the code representing requests and queries sent to and responses received from the Verification API are structured similarly to those that are sent and received using the Verification API itself.

The code sample below is an example of how to use the .NET SDK to initiate an SMS Verification request. We've also provided an example that accomplishes the same task using the REST API.

//This example initiates a SMS PIN verification request using the .NET SDK. 
using System.Text.Json;
using Sinch;
using Sinch.Verification.Start.Response;

var sinch = new SinchClient("YOUR_access_key", 
                            "YOUR_access_secret", 
                            "YOUR_project_id");

var verification = sinch.Verification("YOUR_application_key", "YOUR_application_secret");

var response = await verification.Verification.StartSms("YOUR_phone_number");
    
Console.WriteLine(JsonSerializer.Serialize(response, new JsonSerializerOptions()
{
    WriteIndented = true
}));

This example highlights the following required to successfully make a Verification API call using the Sinch .NET SDK:

• Client initialization
• Verification domain access
• Endpoint usage
• Field population

Client

When using the Sinch .NET SDK, you initialize communication with the Sinch backend by initializing the .NET SDK's main client class. This client allows you to access the functionality of the Sinch .NET SDK.

Initialization

To start using the Verification API with the SDK, you need to initialize the main client class with your credentials from your Sinch dashboard and additionally create a Verification client object that uses your Verification app credentials.

using Sinch;

var sinch = new SinchClient("YOUR_project_id",
                            "YOUR_access_key", 
                            "YOUR_access_secret");

var verification = sinch.Verification("YOUR_application_key", "YOUR_application_secret");

Or, if you only need to use Verification API:

using Sinch;

var sinch = new SinchClient(default, default, default);

var verification = sinch.Verification("YOUR_application_key", "YOUR_application_secret");

Verification domain

The Sinch .NET SDK organizes different functionalities in the Sinch product suite into domains. These domains are accessible through the client. For example, Sinch.Verification.[Endpoint_Category].[Method()].

Endpoint categories

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

In the Sinch .NET SDK, Verification API endpoints are accessible through the client. The naming convention of the endpoint's representation in the SDK matches the API:

• Verification.Verification
• Verification.VerificationStatus

For example:

    using Sinch;
    using Sinch.Verification.Start.Response;

    StartSmsVerificationResponse response = await verification.Verification.StartSms("YOUR_phone_number");

Verification.Verification endpoint category

The Verification.Verification category of the .NET SDK corresponds corresponds to the verifications start endpoint. The mapping between the API operations and corresponding .NET methods are described below:

Verification.VerificationStatus endpoint category

The Verification.VerificationStatus category of the .NET SDK corresponds to the verifications endpoint. The mapping between the API operations and corresponding .NET methods are described below:

Request and query parameters

Requests and queries made using the .NET SDK are similar to those made using the Verification API. Many of the fields are named and structured similarly. For example, consider a request to check on the status of a verification request by using the Identity of the request. One request is using the REST API, and the other is using our .NET SDK:

    var response = await verification.VerificationStatus.GetByIdentity("YOUR_phone_number", VerificationMethod.Sms);

    var request = client.GetAsync("https://verification.api.sinch.com/verification/v1/verifications/" + "YOUR_verification_method" + "/number/" + "YOUR_phone_number").Result;

Note that the path parameters that are used in the API are all passed as arguments to the corresponding .NET method.

Field name differences

When translating field names from the Verification API to the .NET SDK, remember that many of the API field names are in camelCase. In the .NET SDK, field names are in PascalCase. This pattern change manages almost all field name translations between the API and the SDK.

Below is a table detailing field names present in the Verification API and their modified counterparts in the Verification API .NET SDK:

Additionally, there are certain fields that are represented by an .NET enum value instead of a string. For example:

Responses

Response fields match the API responses. They are delivered as .NET objects. If there are any responses that differ significantly from the API responses, we note them in the endpoint category documentation.