Smart CNAM API

Smart CNAM API validates phone numbers and identifies the name or business to which the phone number belongs.

Smart CNAM API 3.1

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

Request

query Parameters

phone required	string The phone number in E.164 or local format. The default country calling code is +1 (USA). 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

header Parameters

x-api-key

required

string

The API Key.

Example: {{apiKey}}

Responses

200

Successful reverse phone response.

Response Schema: application/json

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.
	(PhoneOwnerPersonSmartCNAM (object or null)) The primary owner of the phone number.
	object (PartialError)
warnings	Array of strings Warnings returned as part of the response, if applicable. The possible values include - `Invalid Input`, `International number. Not authorized`, or `Missing Input`.

400

Bad Request: Indicates that the server cannot process the request due to client-side errors.

403

Invalid API Key: Indicates that the API key is either incorrect or has been deactivated.
API Key Missing: Indicates that your request did not include an API key.
API Key Expired: Indicates that the API key has expired.

429

Too Many Requests: API Key has exceeded its rate limit.

500

Internal Server Error: Indicates that the server encountered an unexpected error.

get/3.1/cnam

Request samples

curl --location --request GET '/https://api.trestleiq.com/3.1/cnam?phone=2069735100&phone.country_hint=US'  
  --header 'x-api-key: [insert_api_key]'  
  --header 'Accept: application/json'

Response samples

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"
}

➔ Next to Phone Validation API