Skip to content

Reach Authentix API

The Reach Authentix API lets you easily add a second layer of security to your applications and enable user verification via multiple channels.

Information Circle

At the moment, Reach Authentix API supports the following channels:

  • SMS

  • Email

We are continuously working to add additionnal channels.

Base URL

Reach Authentix API from TalkyLabs are served over HTTPS using the following base URL:

https://api.reach.talkylabs.com/rest/authentix/v1

Authentication

All requests made to the API must be authenticated. The Reach Authentix API from TalkyLabs uses the API key as the authentication mechanism.

Use your API User and API Key (both information can be be found in the console) simultaneously in order to authenticate when sending requests to the Reach platform.

The API User acts as an identifer of your Applet while the API Key, in addition to act as a password, allows to determine the setting in which your requests are operating.

The Reach platform defines two operational settings and enables you to switch from one to the other as seamlessly as possible:

  • Sandbox mode
  • Production mode

Sandbox mode

The sandbox mode enables you to easily test the integration of your application with the Reach platform at no cost.

To operate in that mode, simply use the Test API Key in conjuction with the API User when sending request to the Reach platform.

Production mode

Once you are satisfied with your integration and you want to go live, you can easily switch to the production mode by simply using the Live API Key instead of the Test API Key.

Again, the API User, Test API Key, and Live API Key can be be found in the console.

The code samples in the API documentation highlight how to provide your credentials when using curl or a client library to interact with the Reach platform. in the snippet below, we show an example of how this is done using curl.

curl -X GET https://api.reach.talkylabs.com/rest/authentix/v1/configurations -H "ApiUser: <API_USER>" -H "ApiKey: <API_KEY>"

You need to provide the ApiUser and ApiKey associated with your applet. This information could be found in the settings of the applet.

How does Reach Authentix API work ?

Three steps are needed in order to verify a given user using Reach Authentix API.

Step 1: Create a Authentix configuration

A Authentix configuration is a set of settings used to define and send an authentication code to a user. This includes, for example:

Information Circle
  • the length of the authentication code,
  • the message template,
  • and so on...

A configuaration can be created via the web application or directly using the Reach Authentix API. This step does not need to be performed every time one wants to use the API. Indeed, once created, a configuration can be used to verify several users in the future.

Step 2: Send an authentication code

A configuration is used to send an authentication code via the selected channel to a user. For now, the supported channels are sms, and email. We are working hard to support additional channels. Newly created authentications will have a status of awaiting.

Step 3: Verify the authentication code

This step allows to verify that the code submitted by the user matched the one sent previously. If, there is a match, then the status of the authentication changes from awaiting to passed. Otherwise, the status remains awaiting until either it is verified or it expires. In the latter case, the status becomes expired.

Pagination

The Reach platform uses offset-based pagination to list objects.

For instance, if a search request has a result of 100 objects with pageSize = 10 and page = 5, then objects with indices 51 through 60 are returned.

The client libraries introduce the limit parameter which can be used to indicate the maximum number of objects statisfying the specified criteria to return.

Get Started

Get started with the Reach Authentix API from TalkyLabs is very easy. Simply select your favourite programming language and code. We have multiple client libraries and quickstarts to facilitate your debut. The sample code below show how to start an authentication process using the Authentix API. Exploring the API, you will see how easy it is to check the correctness of authentication token and manage your Authentix configurations. You can also manage your configurations in the web console.

curl -X POST https://api.reach.talkylabs.com/rest/authentix/v1/configurations/CIDXXXXXXXXXXXX/authentications --data-urlencode "dest=+237671234567" --data-urlencode "channel=sms" -H "ApiUser: $REACH_TALKYLABS_API_USER" -H "ApiKey: $REACH_TALKYLABS_API_KEY"

Client libraries

You can interact with the Reach Authentix API from TalkyLabs using your favorite programming language.

For a step-by-step guideline of how to start with a client library, select one of the links below:

Information Circle