2 Factor Authentication

URL:

https://vortext.ca/api/1.0/api.cfm

Method:

POST

You can use this option to verify your customer's accounts with their cell phone number to protect against fraud and, increase security.


How does it work?


Step 1:

You make the initial API call to our endpoint using the following parameters, and we will send a unique 4 digit verification code the phone number supplied in the request.

JSON Parameters:

* = Required parameters

Parameter Value
* action verify
* token Your access token
* phone The cell phone number the user entered into your login form

This API call will return the following example JSON payload:

{ "success":"true", "auth_code":"9BA30303-163E-17DE-6D92D69F2C763C12" }


Step 2:

Step 2: Once the code is received by the user, they enter it into a text input field on your login form. Then you make a second API call to see if they ented the code correctly using the following API call:

Parameter Value
* action verify
* token Your access token
code The code the user entered into the form
auth_code The authorization code you received from the initial API call in step 1.

If the code was entered correctly you will receive the following JSON payload:

{ "success":"true", "message":"Valid code" }


If the code was NOT entered correctly you will receive the following JSON payload:

{ "success":"false", "error":"Invalid code" }