CNAM API

Introduction

This document provides in-depth instructions on how to retrieve caller information* with Tychron’s Caller ID Lookup (CNAM) API. Gather key information on your callers to identify important prospects and avoid scammers. Get more out of your voice services and start building now.

*Please note that CNAM usage is limited to North American numbers only.


Authorization

Please use your API Key's HTTP Token for authorization.


Restrictions

Please note that dips for Canadian numbers are restricted and require additional permissions. Please contact support@tychron.co for additional information.


Request

Endpoint

HTTP/1.1 GET https://api.atlas.tychron.io/api/cnam/:number

Path Parameters

Parameters marked with * are mandatory in all requests.

Parameter Type Default Description
number * String An 11 digit, valid North American Numbering Plan (NANP) number.

Request Headers

Header Default Description Example
Accept application/json or text/plain This header determines what output format should be returned in a response. When this header is given, it will take priority over the default output parameter (JSON).
Accept: application/json
Authorization * Please use your API Key's HTTP Token for authorization.
Authorization: Bearer Rb2VRMSsm0VxHOIcniw6hCJhUqRExQk2

Request Format

HTTP/1.1 GET https://api.atlas.tychron.io/api/cnam/12003004000?output=json|text

Accept: application/json, text/plain
Authorization: Bearer YOUR_API_KEY_HERE

Query Parameters

Parameters marked with * are mandatory in all queries.

Parameter Type Default Description
output String json Queries must be made in either json or plain text.

Response

Response Codes

Code Description Further Comments and possible solutions
200 OK The request was successful and should contain the requested data.
400 Bad Request The payload body of the request is malformed or the request contains invalid parameters.

This error is most likely caused by a text based output with the messaging_lookup or enhanced flags set to true.

Either use json as the output, or unset the messaging_lookup or enhanced flags when using a text based output.
401 Unauthorized The request may be deemed unauthorized due to a number of factors.
  • The Authorization header is not set.
  • The provided API token is invalid, expired, or not active.
  • The requesting account may be unauthorized from making requests.
This error typically results from using an incorrect API token in requests. Check your API token for typos.
If the error persists, please contact support@tychron.co.
402 Payment Required Your account has either an insufficient balance or you have exceeded your credit limit in the request. Please contact support@tychron.co to purchase more credits.
403 Forbidden The user is not permitted to make the specified request(s).
This error currently only applies to Canadian dips, as additional permissions are required for Canadian numbers.
If you require Canadian dips, please contact support@tychron.co for additional details.
415 Unsupported Media Type The content-type used to make the request is not supported. This endpoint only requires a GET request with query parameters. Please remove the Content-Type header from your request.
422 Unprocessable Entity The parameters of the request body have failed validation or contain invalid values. The response body will contain specific details for the request failure. Correct the request parameters based on these details.
500 Internal Server Error The request has not been fulfilled due to a server error.

Please report this error and contact support@tychron.co for further assistance.

Response Headers

Name Description Example
X-Request-ID An ID used to identify the HTTP request.
X-Request-ID: wGvPFqerkrPGm3T0
X-CDR-ID An ID used to identify the CDR (Call Detail Record) generated by the request. Please provide this ID for any billing questions when contacting support.
X-CDR-ID: 01EYVS5A5G7MAJVM25VWZCYKVY

Response Format

JSON

HTTP/1.1 200 OK

Content-Type: application/json
X-CDR-ID: AN_ID
{
  "data": {
    "number": "12003004000",
    "cnam": "JOHN DOE"
  }
}
Attributes

Parameters marked with * are mandatory in all queries.

Parameter Type Default Description
Root
data * Data A top-level map containing dip data.
errors * List<Error> A top-level map containing any request errors.
Data
number * String The number used initially in the request.
cnam String The cname value of the number.

Text

HTTP/1.1 200 OK

Content-Type: text/plain
JOHN DOE

cURL Examples

JSON Example

curl \
  -H "Authorization: Bearer KEY" \
  https://api.atlas.tychron.io/api/cnam/12003004000
{"data":{"cnam":"JOHN DOE","number":"12003004000"},"errors":[]}

Text Example

curl \
  -H "Authorization: Bearer KEY" \
  https://api.atlas.tychron.io/api/cnam/12003004000?output=text
JOHN DOE