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"
}
GET
/
3.1
/
cnam
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. Possible values include: Invalid Input, International number. Not authorized, or Missing Input.

​
Error Responses

​
400

  • Invalid Parameters Error: Parameter called incorrectly.
  • Input Field Error: Incorrect parameter information, such as non-existent area code on a phone number.
  • Input Error: No parameters given.
  • Internal Error: If there is an internal error while performing the checks

​
401

  • Bad Request: If ’;’ used as parameter separator in request. Non-UTF-8-encoded request.
  • Not Authorized: No api_key parameter in the request.

​
403

  • Auth Error: API Key is not authorized for that request or expired.
  • Quota Exceeded Error: API Key has exceeded its quota.

​
429 Too Many Requests

  • API Key has exceeded its rate limit.

​
500 Internal Server Error

  • An unexpected error occurred on the server.