SMS Compliance

curl --request GET \
  --url https://api.example.com/api/businesses/me/phone-compliance

const options = {method: 'GET'};

fetch('https://api.example.com/api/businesses/me/phone-compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/businesses/me/phone-compliance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/api/businesses/me/phone-compliance"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/businesses/me/phone-compliance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

GET

api

businesses

phone-compliance

SMS Compliance

curl --request GET \
  --url https://api.example.com/api/businesses/me/phone-compliance

const options = {method: 'GET'};

fetch('https://api.example.com/api/businesses/me/phone-compliance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/businesses/me/phone-compliance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.example.com/api/businesses/me/phone-compliance"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/businesses/me/phone-compliance")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

Phone Compliance covers the required carrier registration flow for NearIQ-owned SMS numbers. The customer flow is:

Provision a business phone number.
Register the number or business for SMS compliance.
Wait for carrier approval.
Send SMS only after the number is approved.

In API terms: provision the number, register compliance, wait for approval, then send. NearIQ keeps voice calling separate. Voice can continue while SMS compliance is pending, but outbound SMS returns sms_compliance_pending until the relevant toll-free verification or 10DLC campaign is approved.

GET /api/businesses/me/phone-compliance

Returns compliance records for the active business, including status, rejection details, submitted dates, and the matching phone number.

curl "https://app.neariq.io/api/businesses/me/phone-compliance" \
  -H "Cookie: neariq-session=..."

POST /api/businesses/me/phone-compliance

Submits compliance for the active business phone number. Toll-free numbers use carrier toll-free verification. Local US numbers use A2P 10DLC brand registration and campaign registration through the configured Messaging Service.

curl -X POST "https://app.neariq.io/api/businesses/me/phone-compliance" \
  -H "Content-Type: application/json" \
  -H "Cookie: neariq-session=..." \
  -d '{
    "phoneNumberId": "00000000-0000-4000-8000-000000000000",
    "businessName": "Aster Grove Fitness",
    "businessWebsite": "https://aster.example",
    "businessType": "PRIVATE_PROFIT",
    "businessStreetAddress": "100 Market St",
    "businessCity": "Austin",
    "businessStateProvinceRegion": "TX",
    "businessPostalCode": "78701",
    "businessCountry": "US",
    "businessContactFirstName": "Ari",
    "businessContactLastName": "Rivera",
    "businessContactEmail": "owner@example.com",
    "businessContactPhone": "+15125550123",
    "useCaseCategories": ["CUSTOMER_CARE"],
    "useCaseSummary": "Customer care, review requests, reminders, and local business updates.",
    "productionMessageSample": "Hi, this is Aster Grove Fitness. Reply STOP to opt out.",
    "optInType": "WEB_FORM",
    "messageVolume": "100",
    "messageSamples": ["Hi, this is Aster Grove Fitness. Reply STOP to opt out."]
  }'

PATCH /api/businesses/me/phone-compliance/

Updates and resubmits a rejected or draft registration. The body accepts the same fields as POST, but all fields are optional.

POST /api/compliance/status-callback

Signed communications-provider callback endpoint for compliance status changes. It updates verification and linked phone-number records. If callbacks are missed, NearIQ checks pending registrations on a regular schedule. When the status changes, NearIQ sends branded transactional email to the account notification email, profile email, or registration contact email:

Approved: “Your SMS number is ready!”
Rejected/action required/expired: “SMS verification needs attention”
Pending after three days: “Your SMS number is being reviewed”
Pending after seven days: “We’ve escalated your verification - no action needed from you”

Customer email bodies stay provider-neutral. Daily compliance monitoring records pending reminders and escalations, then notifies support for stuck reviews when that internal support intake is configured.

SMS Send Gate

All outbound SMS sends check the linked phone number before contacting the communications provider. If approval is not complete, the API returns:

{
  "error": "sms_compliance_pending",
  "message": "SMS sending requires compliance approval. Current status: pending_review",
  "complianceStatus": "pending_review"
}

Admin

Admins can audit all registrations:

curl "https://app.neariq.io/api/admin/phone-compliance?status=pending_review" \
  -H "Cookie: neariq-session=..."

SMS Voice and Phone Numbers

API Reference

Endpoints

Webhooks

SMS Compliance

GET /api/businesses/me/phone-compliance

POST /api/businesses/me/phone-compliance

PATCH /api/businesses/me/phone-compliance/

POST /api/compliance/status-callback

SMS Send Gate

Admin

​GET /api/businesses/me/phone-compliance

​POST /api/businesses/me/phone-compliance

​PATCH /api/businesses/me/phone-compliance/

​POST /api/compliance/status-callback

​SMS Send Gate

​Admin

GET /api/businesses/me/phone-compliance

POST /api/businesses/me/phone-compliance

PATCH /api/businesses/me/phone-compliance/

POST /api/compliance/status-callback

SMS Send Gate

Admin