Skip to main content
curl --request GET \
  --url "https://api.trestleiq.com/3.1/cnam?phone=2069735100&phone.country_hint=US" \
  --header "x-api-key: YOUR_API_KEY" \
  --header "Accept: application/json"
{
  "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
  "is_valid": true,
  "belongs_to": {
    "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
    "name": "Waidong L Syrws",
    "firstname": "Waidong",
    "middlename": "L",
    "lastname": "Syrws"
  },
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}
curl --request GET \
  --url "https://api.trestleiq.com/3.1/cnam?phone=2069735100&phone.country_hint=US" \
  --header "x-api-key: YOUR_API_KEY" \
  --header "Accept: application/json"
{
  "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
  "is_valid": true,
  "belongs_to": {
    "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
    "name": "Waidong L Syrws",
    "firstname": "Waidong",
    "middlename": "L",
    "lastname": "Syrws"
  },
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}

Smart CNAM API 3.1

GET https://api.trestleiq.com/3.1/cnam?api_key=[insert_key]&phone=[insert_phone_number]

Query Parameters

phone
string
required
The phone number in E.164 or local format. Example: phone=2069735100
phone.country_hint
string (ISO-3166-2)
The ISO-3166 alpha-2 country code of the phone number. See: ISO-3166. Example: phone.country_hint=US

Headers

x-api-key
string
required
Your API key for authentication. Example: {{ apiKey }}

Response

id
string or null <Phone.<uuid>>
The persistent ID of the phone number.
is_valid
boolean or null
True if the phone number is valid.
belongs_to
(PhoneOwnerPersonSmartCNAM (object or null))
The primary owner of the phone number.
error
object(PartialError)
Error details in case of an error.
warnings
string[]
Warnings returned as part of the response, if applicable.

Enum: Invalid Input International number. Not authorized Missing Input

Error Responses

400 Bad Request

The server cannot process the request due to client-side errors.Check for: Syntax errors in the request script, malformed JSON, or invalid parameters.

403 Forbidden

The request is understood, but the server is refusing to fulfill it.
  • Invalid API Key: The key is incorrect or deactivated. Check for: Trailing spaces, syntax errors, or incorrect character counts.
  • API Key Missing: The request header did not include an API key.
  • API Key Disabled (Portal Issue): The key is inactive. Check for: Insufficient funds in your self-serve wallet or if a Trestle Admin manually deactivated your API key.
  • API Key does not have Product Access (Portal Issue): The API key is active, but it is not enabled for this product or API version. Check for: Incorrect endpoint, incorrect API version, or missing product access on the key.
  • API Key Expired: The key has reached its end-of-life (primarily affects Trial users).

429 Too Many Requests

You have sent too many requests in a given amount of time.
  • Rate Limit Exceeded: You have surpassed the queries-per-second (QPS) threshold for your tier.
  • Quota Exceeded (Portal Issue): You have reached the total volume allowed for your current billing cycle. Upgrade your plan in the portal to resume service.

500 Internal Server Error

An unexpected error occurred on the server side. Please contact support if this persists.