Documentation

API Reference

Validate phone numbers directly from your own code via REST. Your API key is tied to your CRM location and shares the same monthly quota as your plan.

Get Your API Key

API keys are generated automatically when you install Phone Validator on your CRM location. To find your key:

  1. Open Phone Validator from your business account.
  2. Navigate to the Settings tab.
  3. Scroll to the API Access section — your key is shown there.
  4. Click the eye icon to reveal it, then copy it.

Base URL

https://phonevalidator-server.expertlevel.io/api/public/v1

All endpoints accept and return application/json. Every request requires an X-API-Key header.

Quick Start

  1. Install the app on your CRM location and copy your API key from Settings → API Access.
  2. Include X-API-Key: your_key on every request.
  3. Call POST /validate with a phone number.
curl -X POST https://phonevalidator-server.expertlevel.io/api/public/v1/validate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone": "+16505550123"}'

Endpoints

POST/validate🔑 Validate a phone number

Headers

X-API-Key: YOUR_API_KEY

Request Body

{
  "phone": "+16505550123"   // E.164 or any common format
}

Response

{
  "phone": "+16505550123",
  "is_valid": true,
  "line_type": "mobile",
  "carrier": "T-Mobile USA, Inc.",
  "country": "United States",
  "country_code": "US",
  "region": "California",
  "is_voip": false,
  "line_status": "active",
  "risk_level": "low",
  "international_format": "+1 650-555-0123",
  "national_format": "(650) 555-0123",
  "timezone": "America/Los_Angeles",
  "meta": {
    "usage": 4,
    "limit": 2000,
    "remaining": 1996
  }
}
GET/me🔑 Check usage & quota
{
  "location_id": "abc123",
  "plan": "starter",
  "monthly_usage": 4,
  "monthly_limit": 2000,
  "remaining": 1996
}

Error Codes

StatusMeaning
401Missing or invalid X-API-Key header
422Validation error — check request body fields
429Monthly validation limit reached for your plan
500Internal server error — contact support

Plans & Limits

API usage counts against the same monthly quota as your CRM app usage. Limits reset on the 1st of each month.

PlanMonthly LimitPrice
Free50 / month$0
Starter2,000 / month$29 / location / month
Pro10,000 / month$59 / location / month

To upgrade your plan, open Phone Validator in your CRM and go to Settings → Billing Plan.