Introduction

About the Service

With our fixable Verify APIs solution we do offer more than a solution, we offer a solution that can fit with your business needs with two steps, generate the code and verify it.

Get Started

To start using Verify you need to create an account at Delevera and once the account is been activated you will have 1.0 SAR for testing, also you can go to the developer tools to generate your API key by press on get API Key.

Verify service using default sender name for text messages which is “Verify”, and if you wish to create your own sender name you need to send an email for support specifying your account ,sender name and the service which is “Verify” as well you can define sender number for voice message but you need to have at least 100.00 SAR in your balance.

enter image description here

Reports

Delevera Provide a modern dashboard to get a very elegant report for each service you are using, with simple clicks you can generate the report you like in not time. For Verify sent by SMS, all you need to do is to go to “manage SMS” and then to “report summary” and for the voice you can do it by going to “Manage Voice” and then “sent calls”.

Base URL

All requests to the Short Code verify API must contain: https://delevera.com/api/verify.php

Authentication

Delevera API provides easy access control capabilities that help keep user data, configuration settings and conversations secure. All requests should be Authenticated using one of the following methods:

To authenticate your request, using username / password you must provide the following parameters:

Parameter Description Required
numbers This could be number or username Yes
password The password of the account Yes

To authenticate your request, using API Key you must provide the following parameters:

Parameter Description Required
apiKey String of characters generated by the system Yes

To generate your code, you must provide the following parameters Beside the Authentication Parameters:

post https://delevera.com/api/verify.php

Generate the code Parameters

Authorizations is required via Authentication

Parameter Description Required Default
numbers mobile number that will receive the activation code SMS, number must be in international format, without 00 or symbol (+). Yes ""
sender message sender No Verify
method specifies how to send the verification code, you can choose between “sms” or “call”. sms “which is the default” will send verification code as SMS message, and call will send the verification code as a Voice call No sms
lang specifies the language of SMS message/Voice call, “en” or “ar”, “ar“ is the default No ar
requestId you can specify a unique ID for each verification process through this variable. If this variable is passed to the verify API, it must be used during the check verification code process No account ID
returnJson when send this variable with value 1 the result will be return in JSON format No 0

Generate the code Response Example

{
status: 1,
ResponseStatus: "success",
Data: 
{
result: 5,
MessageAr: "تم إرسال كود التحقق بنجاح",
MessageEn: "Activation code sent successfully"
},
Error: null
}

To check the code, you must provide the following parameters beside the Authentication Parameters:

post

Checking the code Parameters

Authorizations is required via Authentication

Parameter Description Required
numbers mobile number that will receive the activation code SMS, number must be in international format, without 00 or symbol (+). Yes
activeKey The verification code which sent to the mobile number through the verification request process Yes

Checking the code Response Example


{
    "status": 1,
    "ResponseStatus": "success",
    "Data": {
        "id": null,
        "result": 10,
        "MessageAr": "تمت عمليه التفعيل بنجاح",
        "MessageEn": "The activation has been successful"
    },
    "Error": null
}

appendix

Format

The following code shows an example for Generating the code:

?apiKey=xxxxxxxxxxxxxxxxx&numbers=9665xxxxxxxx&sender=verify&method=sms&lang=ar&requestId=55241&returnJson=1

The following code shows an example for Checking the code:

?apiKey=xxxxxxxxxxxxxxxxx&numbers=9665xxxxxxxx&activeKey=8854

Keys and Values

Key Value
Status Your connection to API status:
ResponseStatus Process Status Success: The operation was successful, failed: The operation failed.
Data The results if the operation is successful.
Error The results if the operation is successful.
Status values
0 no connection.
1 you are connected to API

Data values

Parameter Description
result The process`s result as numerical value
messageAr The process`s result as a text in Arabic
messageEn The process`s result as a text in English

Error values

Parameter Description
ErrorCode The process`s result as numerical value.
messageAr The process`s result as a text in Arabic
messageEn The process`s result as a text in English

Results values

Code Description
0 Connection failed to delevera.com server
1 Invalid mobile number (or invalid username or invalid apiKey).
2 Invalid password.
3 Mobile number is not specified or incorrect.
4 Your balance is not enough.
5 Activation code sent successfully.
6 Unknown error Please contact technical support, this case holds more than one error such as: Sender name is not authorized or Your balance is 0.
7 The activation code has already been sent, you can re-send it in (s) second, Get JSON result form more details
8 You have exceeded the allowed number of attempts, change requestId to verify mobile number.
9 Activation call sent successfully.
10 Activation process completed successfully.
11 Activation code is incorrect.
12 Attempts to enter activation code have been exhausted.
13 Mobile number is already verified