Number Intelligence

contiguity.intelligence.lookup

Requires the number_intelligence entitlement. Rate limited to 6 requests per minute.

The number must be E.164.

By default this returns carrier, CNAM, and porting data. imessage and facetime are null unless you set those flags. The two flags are independent. contiguity_risk_scoring_beta: true requires both availability flags. If you only pass the risk flag, the SDK also sends imessage=true and facetime=true. When risk scoring is returned, imessage and facetime are booleans (never null).

const lookup = await contiguity.intelligence.lookup("+13129457420");

const with_availability = await contiguity.intelligence.lookup("+13129457420", {
    imessage: true,
    facetime: true,
});

const with_risk = await contiguity.intelligence.lookup("+13129457420", {
    imessage: true,
    facetime: true,
    contiguity_risk_scoring_beta: true,
});

intelligence.lookup(number, params?)

string

required

Phone number in E.164 format.

boolean

default:"false"

Include iMessage availability.

boolean

default:"false"

Include FaceTime availability.

boolean

default:"false"

Include risk scoring. Requires both availability flags. The SDK sets them if you omit them.

Response

string | null

E.164 phone number.

string | null

Nationally formatted number, e.g. (312) 945-7420.

string | null

ISO 3166-1 alpha-2 country code.

string | null

CNAM caller name, if the database has one.

string | null

Portability line type (mobile, landline, voip).

string | null

Rate center city.

string | null

State or region.

object | null

Current carrier.

Show Carrier properties

string | null

Current carrier name.

string | null

Carrier-reported line type (mobile, landline, voip).

string | null

Mobile country code.

string | null

Mobile network code.

object | null

Porting data.

Show Ported properties

boolean

Whether the number has been ported.

string | null

Port date (YYYY-MM-DD), if known.

string | null

Carrier before the port.

string | null

Carrier after the port.

boolean | null

iMessage availability. null unless imessage=true.

boolean | null

FaceTime availability. null unless facetime=true.

object | null

Risk scoring. Only returned when contiguity_risk_scoring_beta=true. Useful with other fraud signals to determine if a user is risky.

Show Risk scoring properties

number

Risk from 0.00 (safe) to 0.99 (very high).

string

low, medium, high, or very_high.

number

Confidence from 0.00 to 0.99.

object

Request metadata: id, timestamp, api_version, object.

`contiguity_risk_scoring_beta.level`	score
`low`	`< 0.2`
`medium`	`< 0.45`
`high`	`< 0.7`
`very_high`	otherwise

Types

import type {
    IntelligenceLookupParams,
    IntelligenceLookupResponse,
    IntelligenceRiskScore,
    IntelligenceRiskLevel,
} from "contiguity";

Getting Started

SDK Documentation by Product

SDK Documentation by Language

intelligence.lookup(number, params?)

Response

Types

​intelligence.lookup(number, params?)

​Response

​Types

intelligence.lookup(number, params?)

Response

Types