Skip to main content
POST
fraud.phone.inspect

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
phone
string
required

International phone number with country code, without spaces.

Maximum string length: 19
Pattern: ^\+?[0-9]{7,18}$
includeHlr
boolean

Request carrier reachability; paid extra, default off.

includeCallerName
boolean

Request caller display name; paid extra, default off.

includeSimSwap
boolean

Request SIM-change facts; paid extra, default off.

includePorting
boolean

Request number-porting facts; paid extra, default off.

includeTelco
boolean

Request factual telecom extras; paid extra, default off.

includeRawRegistrations
boolean

Request individual account registrations; default off.

Response

The result

phone
string
required

Checked phone.

Required string length: 1 - 19
valid
boolean

Whether the number is valid.

carrier
string

Carrier name.

Required string length: 1 - 100
countryCode
string

Country code.

Required string length: 1 - 100
lineType
string

Line type.

Required string length: 1 - 100
disposable
boolean

Temporary number.

registrations
object[]

Aggregated registration facts; no person rating.

Maximum array length: 100
callerName
string

Requested caller display name; does not prove identity.

Required string length: 1 - 100
hlr
object

Requested carrier reachability facts.

simSwap
object

Requested SIM-change evidence.

porting
object

Requested porting evidence.

rawRegistrations
object[]

Requested registration facts.