Veriphone¶
The Veriphone modules allow you to verify and retrieve the phone number details in your Veriphone account.
Getting Started with Veriphone¶
Prerequisites
- A Veriphone account
In order to use Veriphone with Ibexa Connect, it is necessary to have a Veriphone account. If you do not have one, you can create a Veriphone account at veriphone.io.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Veriphone to Ibexa Connect¶
To connect your Veriphone account to Ibexa Connect you need to obtain the API Key from your Veriphone account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Log in to your Veriphone account.
2. From the Dashboard, copy the API Key to your clipboard.
3. Go to Ibexa Connect and open the Veriphone module's Create a connection dialog.
4. In the Connection name field, enter a name for the connection.
5. In the API Key field, enter the API key copied in step 2, and click Continue.
The connection has been established.
Actions¶
Verify a Phone¶
Takes a phone number and an optional default-country as input, and tells you if the number is valid.
| Phone | Enter the phone number you want to verify. |
| Country | Enter the two-character country code to which the phone belongs to. For example, US. |
Get a Phone Example¶
Returns an example (dummy) phone number for any country/phone-type combination.
Type |
Select the phone type:
|
Default Country |
Enter the two-character country code to which the phone belongs to. For example, |
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Veriphone API Documentation. |
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - Get an Example¶
The following API call returns a dummy mobile example from your Veriphone account:
URL: /v2/example
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body. In our example, a dummy phone number verification results were returned:
