Receiving Server
The receiving server is a special server which is used to receive the authentication message sent by the user. The job of this server is to pick up the authentication message sent by the user; convert the origination ID (either the user's phone number or the user's email address) to a SHA256 hash; and forward a JSON to our authentication server.
As explained earlier; the message could be via an SMS that the user sent as per the instructions that were displayed on the front page. Or the message could be sent as the SUBJECT line of a blank email -- again the instructions would be displayed on the front page.
In these docs, we assume that the authentication message has been sent via SMS -- but really speaking; the docs equally applies to the authentication message being sent via the SUBJECT line of an email from the user's email address.
User our own receiving server, and save time
In order to make the lives of merchants who would user our system easier; we have already implemented TWO such receiving servers. One receiving server whose "Receiver Code" (RC) is "SR1" and the other is "SR2" "SR1" receiver can be used in order to make the merchant's users send the authentication message via SMS. "SR2" receiver can be used by users to send the authentication message as a subject line of an email belonging to the user.
If you (i.e. the merchant) want use either of these receiving servers; you can set them up in the several ways. Each has its own setup cost which has to be paid; and you can choose one of them.
FOR SMS method of authentication, using our own receiving server SR1: You let us choose a Keyword (MSGKEY) for you and we purchase the endpoint on your behalf at the SMS gateway services that we use. (textlocal.in for India and messagebird.com for outside India) In this case, we'll do all the other work needed for you. This is a very easy option for you.
FOR SMS method of authentication, using our own receiving server SR1 but with your SMS gateway account: You can get your own SMS gateway account at either textlocal.in (for India) or messagebird.com (for outside India) or both... and then setup your own keyword there. The gateway/s should be instructed to forward the message to the webhook endpoint of our own receiver SR1. In such a case, you will have to enter the keyword (MSGKEY) you chose in your merchant's configuration.
FOR Email method of authentication, using our own receiving server SR2: You let us choose a Keyword (MSGKEY) and we'll do all the needful for ensuring that emails that are mailed with the authentication message on the subject line to [email protected] are used for your authentication. There are two variants for using this: One where you tolerate ALL kinds of email addresses (i.e. including free and disposable ones) and the second where you decide to exclude free and disposable email addresses. This is also a very easy option for you
FOR Email method of authentication, using our own receiving server SR2 but with a different email address to send to: If you don't want the users to email the authentication message (as a subject line) to our special email address i.e. [email protected], then you will have to create an account at forwardemail.net and setup your own forwarding alias address there, and set a forwarder webhook URL as per our instructions. You would also have to choose a Keyword (MSGKEY) for this. Our system will then guide you further on what would be the webhook URL that you have to use for that alias at forwrdemail.net.
If you want to start your OWN receiving server and use that; the instructions are in the appendix. This is the most complex of them all but we have given this capability for merchants with special needs. Here you would have to configure the webhook URL into which the message has to be sent to in the custom receiving server's configuration.
In case of 2 or 4 our system will tell you what is the URL that you have to use for the webhook endpoint that has to be setup at the SMS/Email gateways. The appendix in this docs has more details on how to setup and use an account at textlocal.in and messagebird.com
Last updated