Phone Validation

GET http://localhost/api/v1/phone/check scope: phone.check

Validates a phone number and flags VOIP/disposable lines.

Parameters

Field Type Optional Description
phone string Required
country string Optional ISO 3166-1 alpha-2 hint (e.g. US) for parsing an ambiguous number.

Example Request

curl "http://localhost/api/v1/phone/check?phone=2025551234" \
  -H "Authorization: Bearer wsk_xxx_xxx"
<?php
$ch = curl_init('http://localhost/api/v1/phone/check?phone=2025551234');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer wsk_xxx_xxx']);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
import requests

response = requests.get("http://localhost/api/v1/phone/check",
    headers={"Authorization": "Bearer wsk_xxx_xxx"},
    params={"phone": "2025551234"},
)

data = response.json()
package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, _ := http.NewRequest("GET", "http://localhost/api/v1/phone/check?phone=2025551234", nil)
	req.Header.Set("Authorization", "Bearer wsk_xxx_xxx")

	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	respBody, _ := io.ReadAll(resp.Body)
	fmt.Println(string(respBody))
}

Example Response

{
  "data": {
    "valid": true, "e164": "+12025551234", "is_voip": false,
    "phone": "2025551234", "is_disposable": false,
    "fraud_score": 0, "risk_score": 0,
    "reasons": ["No risk signals detected"]
  }
}