API on Smart Carrier | Docs

Disconnected Number API

Mon, 01 Jan 0001 00:00:00 +0000

Disconnected Number API

The Disconnected Number API is a JSON-compliant web service that will check if a telephone is in service or not in service based on the carrier’s confidence score. Based on historical data, this API will render a result that is 98% accurate. Due to how carriers provision, connect, and disconnect numbers, no service will guarantee 100% accuracy.

This API requires an API key. Find your key on the Organization settings page of the Smart Carrier dashboard. If you cannot find it, contact support@smartcarrier.io.

STIR/SHAKEN API

Mon, 01 Jan 0001 00:00:00 +0000

STIR/SHAKEN API

The STIR/SHAKEN API (STI-AS) is a web service that signs a call and returns its STIR/SHAKEN attestation level and identity token. Use the result for call routing and verification.

This API requires an API key. Find your key on the Organization settings page of the Smart Carrier dashboard. If you cannot find it, contact support@smartcarrier.io.

To review past requests, see the STIR/SHAKEN log.

Web service information

Field	Value
Endpoint	`https://api.smartcarrier.io/v2/sti-as?`
Method	`GET`
Parameters	`ToNumber`, `FromNumber`
Header	`x-api-key` (get your API key)
Example	`https://api.smartcarrier.io/v2/sti-as?ToNumber=12025550143&FromNumber=8005550199`

Request parameters

Parameter	Type	Description
`ToNumber`	string	The destination telephone number for the call.
`FromNumber`	string	The originating telephone number (calling party or ANI).

Sample response

{
 "RequestGuid": "11111111-2222-3333-4444-555555555555",
 "AccountGuid": "12345678-1234-1234-1234-123456789012",
 "APIKey": "YOUR_API_KEY",
 "FromNumber": "18005550199",
 "ToNumber": "12025550143",
 "Prefix": "",
 "LERG_ToNumber": {
 "RequestGuid": "66666666-7777-8888-9999-000000000000",
 "RoutingNumber": "12025550000",
 "NPA": "202",
 "NXX": "555",
 "Block": "1",
 "USState": "DC",
 "Company": "EXAMPLE TELECOM, INC.",
 "OCN": "1234",
 "RateCenter": "EXAMPLE",
 "CLLI": "EXMPLDCXX01",
 "Assigned_Date": null,
 "PrefixType": "CLEC",
 "SwitchName": "",
 "SwitchType": "",
 "LATA": "999",
 "Country": "US",
 "TollFree": false,
 "IsValid": true,
 "RequestedAt": "2025-01-01T12:00:01.0000000Z",
 "ElapsedMilliseconds": 0
 },
 "NationalDNCStatus": "0",
 "AttestationLevel": "B",
 "STI_Token": "",
 "Identity": "<header>.<payload>.<signature>;info=<https://certificates.smartcarrier.io/CERTIFICATE_ID.cer>;alg=ES256;ppt=shaken",
 "RequestingIP": "203.0.113.10",
 "ProcessingTime": 574,
 "ApplicationVersion": "18",
 "DateTimeRequested": "2025-01-01T12:00:00.0000000Z"
}

The sample shortens Identity. A real response holds the full signed token in each of the three parts.

Enhanced Insights API

Mon, 01 Jan 0001 00:00:00 +0000

Enhanced Insights API

The Enhanced Insights API, also called the LERG / LRN lookup, is a web service that returns LERG and LRN data for a telephone number: the operating company, OCN, line type (prefix type), rate center, LATA, and routing number.

This API requires an API key. Find your key on the Organization settings page of the Smart Carrier dashboard. If you cannot find it, contact support@smartcarrier.io.

AI Numbers API

Mon, 01 Jan 0001 00:00:00 +0000

AI Numbers API

The AI Numbers API is a web service that returns the caller ID to use for a call. Send the number you are calling and your prefix, and the API replies with the caller ID.

This API requires an API key. Find your key on the Organization settings page of the Smart Carrier dashboard. If you cannot find it, contact support@smartcarrier.io.

To review past requests, see the AI Numbers log.