Technical Details
The Identity Insights API provides a single API to access a broad range of attributes related to the carrier, subscriber, or device associated with a phone number. Developers can leverage a single endpoint to retrieve various attributes that would typically require multiple suppliers, CSPs, and integration methods.
Attributes are grouped into Insights, each corresponding to a specific feature set. Availability may vary by geography. The developer simply specifies which Insight(s) to retrieve in a single request.
While some Insights are available without prior registration, others require approval from mobile operators. The table below shows which Insights require approval. Access to these Insights is managed through the "Network Registry". To learn how to request access, follow this guide.
| Insight | Description | Approval Required? | Coverage | Status |
|---|---|---|---|---|
| Format | Validation of a phone number's format and retrieval of information derived from it. | No | Worldwide | Beta |
| Original Carrier | Information about the network was initially assigned. Information based on the numbering plan prefix. | No | Worldwide | Beta |
| Current Carrier | Information about the network the number is currently assigned. | No | Worldwide | Beta |
| SIM Swap | Information on any recent SIM pairing change related to a mobile account. | Register through Network Registry | See Network Features | Beta |
| Location Verification | Verify whether the location of an end-user is within a specified area. | Register through Network Registry | See Network Features | Developer Preview |
| Subscriber Match | Compare end-user data for a phone number with that on file with a network operator. | Register through Network Registry | See Network Features | Developer Preview |
Playground
Use the Playground, a safe and controlled testing environment where API calls return live data only for a small group of allowlisted phone numbers, to start using the Identity Insights API right away. Unlike production, it does not require approval from Operators.
You can use also access the Virtual Operator, a simulated operator that generates fake but deterministic responses for Virtual Numbers.
API Reference
The OpenAPI specification for the Identity Insights API is available here.
Getting Started
Check out Getting Started for a step-by-step guide on how to get up and running with the Identity Insights API.