Login

This resource is to authenticate your customer's via means of an OTP that would be sent to the provided phone number. Here you get to pass their phone number and the telco provider (mtn or airtel).

API Reference ➡

API Object

{
    "status": "successful",
    "data": {
        "session_id": "FsMHSjfv237Sa",
        "result": {
            "title": "Please enter the OTP sent to your phone",
            "form": [
                {
                    "type": "elements.input",
                    "name": "otp",
                    "hint": "Enter OTP",
                    "contentType": "password",
                    "minLength": 6,
                    "maxLength": 6
                }
            ]
        }
    }
}

Telco Authentication Fields

Field	Description	Type
status	This is the status of the API response which could be either failed or successful	string
data	This is the data object of the returned response	object
data.session_id	This is the session id to be used when verifying a phone number	string
data.result	This is the object of the final returned response	object
data.result.title	This is an instruction that is expected of your users.	string
data.result.form	This is the returned form object of the response	object
data.result.form[0].name	This is the html form input type	string
data.result.form[0].type	This is the authentication method that is expected from your customer	string
data.result.form[0].hint	This is the authentication hint that can be sent to your customer	string
data.result.form[0].contentType	This is an html input content-type	string
data.result.form[0].minLength	This is the minimum length of the authentication type	integer
data.result.form[0].maxLength	This is the maximum length of the authentication type	integer