Custom Connector
Numverify Connector
KSA
The Numverify Connector provides a simple interface to access validation of phone numbers and retrieval of a list of supported country information. Designed for developers building applications that require phone number validation or country data, this connector supports querying phone number details and country lists.
Overview
Integration Overview
This document provides a comprehensive guide for each endpoint, its purpose, configuration, and workflow support using the Numverify Connector. The connector forwards HTTP GET requests to the Numverify API, handling query parameters and headers to ensure reliable data retrieval.
- validate_number. Validates phone number details based on provided parameters.
- countries_list. Retrieves a list of countries supported by the Numverify API.
Documentation
Detailed Integration Documentation
Phone Number Validation
| Action | validate_number |
|---|---|
| Purpose | Validates a phone number and retrieves details such as country, carrier, and line type. |
| Parameters | Required: number: Phone number to validate (string, e.g. “+12025550123”). Optional: country_code: Country code for the phone number (string, e.g. “US”). format: Response format (integer, e.g. 1 for formatted output). |
| Configuration | Configure the base URL via CONNECTOR_ENV_NUMVERIFY_BASE_URL. Set CONNECTOR_ENV_NUMVERIFY_API_KEY with a valid Numverify API key. Optionally set CONNECTOR_ENV_PORT (default 8081). |
| Output | Successful: JSON object with phone number details including validity, country, carrier, and line type. Failure: error codes (400 Bad Request, 401 Unauthorized, 404 Not Found, 500 Internal Server Error). |
| Workflow example | Configure the connector, execute a GET request to /api/validate with number=+12025550123, then process the JSON response to display phone number details in a web or mobile application. |
Countries List Retrieval
| Action | countries_list |
|---|---|
| Purpose | Retrieves a list of countries supported by the Numverify API. |
| Parameters | Required: None. Optional: None. |
| Configuration | Configure the base URL via CONNECTOR_ENV_NUMVERIFY_BASE_URL. Set CONNECTOR_ENV_NUMVERIFY_API_KEY with a valid Numverify API key. Optionally set CONNECTOR_ENV_PORT (default 8081). |
| Output | Successful: JSON object with a list of countries including country names and codes. Failure: error codes (400, 401, 404, 500). |
| Workflow example | Configure the connector, execute a GET request to /api/countries, then use the response to populate a list of countries in a web or mobile application. |
Support
For technical support, contact custom-connectors-support@isolutions.sa.