ballerinax/sinch.verification Ballerina library

Overview

This is a generated connector for Sinch Verification API v2.0 OpenAPI specification.

Verify users with SMS, flash calls (missed calls), a regular call, or data verification.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

• Create a Sinch account account
• Obtain tokens by following this guide.

Quickstart

To use the Sinch Verification connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/sinch.verification module into the Ballerina project.

import ballerinax/sinch.verification;

Step 2: Create a new connector instance

Create a verification:ClientConfig with the <USERNAME> and <PASSWORD> obtained, and initialize the connector with it.

verification:ClientConfig clientConfig = {
    auth: {
        username: <USERNAME>,
        password: <PASSWORD>
    }
};

verification:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

   Following is an example to start verification using the connector.

   public function main() {
       verification:InitiateVerificationResource resources = {
           identity: {
               'type: "number",
               endpoint: "+46700000000"
           },
           method: "sms"
       };
   
       verification:InitiateVerificationResponse|error response = baseClient->startVerification(resources);
       if (response is verification:InitiateVerificationResponse) {
           log:printInfo(response.toString());
       } else {
           log:printError(response.message());
       }
   }

2. Use bal run command to compile and run the Ballerina program.