Documentation and APIs

Learn how to use our serverless platform to create voice, video and messaging applications and services by reading our getting started guide. It's the best way to become familiar with the platform architecture and capabilities.

Number Management
SMS
Anonymize
Authenticate – Multi Factor Authentication
Authenticate – One Tap Authentication
Engage
WhatsApp
Programmable Voice(India)
Email

Authenticate – One Tap Authentication

One Tap Authentication enables secure and seamless authentication via mobile operator of the end-user, eliminating the need of passwords/OTPs. One Tap Authentication is used to verify mobile number and active SIM card details of the end-user to ensure that end user is who they claim to be and is in possession and control of the mobile device associated with end user’s mobile number. Authentication process involves two API calls – Initiate and Verify. Initiate API operation is performed first followed by Verify API operation.

Initiate

This API operation sends request to get authentication-trigger URL. This URL must be triggered on end-user’s handset with mobile data network enabled. Mobile number along with active SIM card details of the end-user will be captured, and details will be sent to mobile network operator of the end-user for authentication.

Request Variables
Variable Name Description Data Type
mobile The mobile number of the user in E.164 format
e.g., 91XXXXXXXXXX where “91” is a country code.
String
userIp Public IP address (IPv4 or IPv6) used in the mobile network String
Sample Request (cURL)
copy

curl --request POST \
--url 'https://api.apigw.tatacommunications.com/v1/auth/initiate' \
--header 'Authorization: '
--header 'content-type: application/json' \
--data '{
    "mobile": "XXXXXXXXXXXX",
    "userIp": "XXXXXXXXXXXX"
}'
Response Variables
Variable Name Description Data Type
code Status code Number
transactionId Transaction Id generated for the initiate session String
url Authentication-trigger URL of the supported network operator for the provided mobile number and IP address String
Sample Response
copy

{
    "code": 200,
    "transactionId": "OTA21461388817324d40fc0a-ab3c-4bdc-90bc-7d60ec6412c0",
    "url": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
What’s New