Get CIC Details for Toll-free Phone Number

This request returns CIC data and (optionally) a RespOrg ID for the specified toll-free phone number.

get	/lookup/toll_free/{tollfree_phonenumber}/{calling_number}/{lata}

Sample

A sample GET request to get a CIC and (optionally) a RespOrg ID for a specific toll-free phone number:

curl -X GET \
'https://api.carrierx.com/core/v2/lookup/toll_free/18002446227/12092551162/490?cic=true&resporg=true' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with the CIC and (optionally) RespOrg details:

{
    "cic": "5102",
    "resporg": "TZN99"
}

This request is enabled for Field Filtering.

note

If an empty string is returned for a phone number, it means that the lookup has succeeded but this phone number has no CIC. Also, the following errors may be returned:

• 4xx - general validation errors, such as bad format numbers
• 5xx - unexpected server errors
\

Required Scopes

To query the CIC information the partner must have the following scope enabled:

• lookup.toll_free.allow_cic to query a CIC (using the cic query argument set to true).

To query the RespOrg information (provided as an option in the scope of the CIC Lookup Object) the partner must have the following scope enabled:

• lookup.toll_free.allow_resporg to query a RespOrg's ID (using the resporg query argument set to true).

tip

Contact technical support at support@carrierx.com to enable this option.

Path Arguments

Parameter	Data Type	Description
tollfree_phonenumber required	string	The toll-free phone number to look up a CIC for.
calling_number required	string	The phone number that is placing the call to the toll-free number.
lata required	string	LATA: Local Access and Transport Area, a geographic code representing the location of the call origination.

Query Arguments

Parameter	Data Type	Description
cic	boolean	Determines whether the CIC information should be looked up and shown in the response. Values accepted in this field are true and false. The default value is true. Returns null if set to false.
cic_ttl	integer	Overrides the default CIC cache TTL (in seconds).
resporg	boolean	Determines whether the RespOrg information should be looked up and shown in the response. Values accepted in this field are true and false. The default value is false. Returns null if set to false.
resporg_ttl	integer	Overrides the default RespOrg cache TTL (in seconds).