VerifyMe Docs

Create an App

Creating an App
Process:
1) Go to MyApps.
go to my apps
2) Click Create App. Maximum number of allowable apps is 5.
click app name
3) Fill out required fields.

App Name is your app's name.

Redirect url , upon successful verification, a response will be sent to the redirect url via POST REQUEST. See App Subscription Url for more info.

Access Token Expiration each registered mobile number will have a corresponding access token. The access token will expire depending on the days specified.

click app name
Prerequisites:
1) Created an app.
Process:
1) Go to MyApps.
go to my apps
2) Select app.
click app name
3) The system will redirect you to the selected app's page. Click show to get the App Key and App Secret.
click show
Prerequisites:
1) Created an app.
2) Obtained App key and App Subscription URL.
App Subscription URL:
From your selected app, get the App Subscription URL.
click app
There are TWO ways to opt in a mobile number: API or web form.


Via Web form Process:
1) Redirect user to App subscription URL to your subscriber.
app subscription page
2) The subscriber must input his/her 11 digit mobile number and click Send verification code to submit.
3) The subscriber should receive a SMS with the code;
3rd pic
4) The subscriber will be redirected to the verification page.
5) Subscriber must input the code received then submit by clicking Verify.
verify code
6) An alert should appear if the process failed (error) and will be redirected to the redirect URL. if successful, the user will be redirected to the redirect URL specified WITH PARAMETERS.
redirect url location
7) On handling the response parameters, use GET on your redirect URL. GET id.
id - the index on VerifyMe DB wherein the access token is stored, to be used on CHECK TOKEN API ENDPOINT.

SAMPLE:
http://example.com?id=999


ENROLL A MOBILE NUMBER
Opt-in a mobile number via POST request
Make a POST REQUEST with your app_key and mobile_number
http://verifyme.ph/api/v1/opt_num/
REQUEST PARAMETERS:
app_key
mobile_number
The response will be in json format;

Sample Response:

Successful:
{
"success" : "true",

}
Failed:
{
"success" : "false",
“msg" : "Number already opt-in."

}

VERIFY A MOBILE NUMBER
Verify a mobile number (verify code) via POST request
Make a POST REQUEST with your app_key , mobile_number , code and two_factor
http://verifyme.ph/api/v1/verify_num/
REQUEST PARAMETERS:
app_key
mobile_number
code
two_factor
The response will be on json format;

Sample Response:

Successful:
{
"success" : "true",
"msg": "Code validated successfully."

}
Failed:
{
"success" : "false",
“msg" : "Pin already expired."

}

CHECK TOKEN
Check an access token's availability using GET request with ID & App Key.
Make a GET REQUEST with your ID (obtained from VerifyMe Redirect) and app_key
http://verifyme.ph/api/v1/check_token/ ID/ APP_KEY
http://verifyme.ph/api/v1/check_token/72/ae7162z871raskjz876
REQUEST PARAMETERS:
ID
app_key

Sample Response:

Successful:
{
"id":"01",
"access_token":"qwertyuiop"

}
Failed:
{
"id":"false",
"access_token":"false",
"msg":"Number not opt in"

}

GET OPT-IN MOBILE NUMBERS
Get the opt-in mobile numbers via GET Request in JSON Format
Use GET CONTENTS / GET method on this URI:
http://verifyme.ph/api/v1/app_tokens/ APP_KEY
Replace APP_KEY with your app's app key.
The response will be on json format;

Sample Response (one user):

Expired Token:
{
"id" : 39,
“mobile_number" :"U2Fsdqwiqwoiq5jiGatEFZqESzhVci+NtuAeNZ1g=\n",
"created_at" : "2016-05-26T02:24:05.470Z",
"access_token" : "expired"

}
Available/Working token:
{
"id" : 40,
“mobile_number" :"U2Fsdqwiqwoiq5jiGatEFZqESzhVci+NtuAeNZ1g=\n",
"created_at" : "2016-05-26T02:24:05.470Z",
"access_token" : "c8n3u982ut982u9823jxu89rf2ue92o"

}

Sample Response Parameters:

id is the unique and incremental count of that specific field/row.

mobile_number is the encrypted subscriber's number.

created_at determines when the data is created in datetime format.

access_token has two outputs; 'Expired' or the Access token itself. An available/ working access token is used to decrypt the mobile number.


DECRYPT A MOBILE NUMBER
Decrypt a mobile number via POST REQUEST.
Make a POST REQUEST with your access_token and secret
http://verifyme.ph/api/v1/get_numbers/
REQUEST PARAMETERS:
access_token
secret
The response will be in json format;

Sample Response:

Successful:
{
"success" : "true",
"mobile_number": "0915-xxx-xxxx"

}
Failed:
{
"success" : "false",
“msg" : "Error, decryption failed."

}

DECRYPT MULTIPLE MOBILE NUMBERS
Decrypt multiple mobile numbers via POST REQUEST using JSON.
Make a POST REQUEST with your access_token and secret and parse them into JSON.
http://verifyme.ph/api/v1/dec/
REQUEST PARAMETERS:
access_token
secret
data

Sample Request:

Follow this format:

{"data":[{"access_token":"f4a1209d1ca6f5a7c64746b5bb9b3a17","secret":"e17eb6bd8f0bf84376dbfab860925bc7"},{"access_token":"a6a9aceb03360669988f897596bb39ba","secret":"e17eb6bd8f0bf84376dbfab860925bc7"}]}

The response will be an array of mobile numbers.

Sample Response:

Successful:

"0915-xxx-xxxx","0915-xxx-xxxx"

Failed:
{
"success" : "false",
“msg" : "Bad decrypt."

}