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

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

Sample Response

copy

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

Verify

This API operation returns authentication status response from mobile network operator for the authentication request of end user whose details were captured during Initiate API operation and during the trigger of authentication-trigger URL.

Response Variables

Sample Response

copy

curl --request POST \
--url 'https://api.apigw.tatacommunications.com/v1/auth/verify' \
--header 'Authorization: '
--header 'content-type: application/json' \
--data '{
	"transactionId": "OTA21461388817324d40fc0a-ab3c-4bdc-90bc-7d60ec6412c0"
}'

Response Variables

Sample Response

copy

{
    "code": 200,
    "transactionId": "OTA21461388817324d40fc0a-ab3c-4bdc-90bc-7d60ec6412c0",
    "message": "Phone number and User Ip are both correct",
    "status": "success"
}

Authentication response received from mobile network operator can be pushed through callback URL (webhook) configured for Enterprise customers. The following parameters are passed in the callback request.

API Method: POST
Callback Request Body Format: JSON
Callback Request Body

copy

{
    "transactionId": "string",
    "status": "string",
    "timestamp": "string"
}