How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vonage Identity Insights API

Provides real-time intelligence about a phone number.

Vonage Identity Insights API is one of 59 APIs that Vonage publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 74 JSON Schema definitions.

Tagged areas include Identity Insights. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, and 74 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api-{region}.vonage.com/identity-insights/v1.

1 operations 1 paths 28 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://rest.nexmo.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Vonage Identity Insights API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Identity Insights 1

Provides real-time intelligence about a phone number.

POST
/requests
Retrieve identity insights from a phone number
getInsights body → 200400401405415422429500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are SubscriberMatchInsightResponse (13 properties), SubscriberMatchInsightRequest (11 properties), FormatInsightResponse (9 properties), OriginalCarrierInsightResponse (5 properties). Each schema is shown below with its type and property counts.

AggregatedInsightRequest
object
3 properties 2 required
MatchAddressResult
string
CurrentCarrierInsightRequest
object
Request the currentcarrier insight. This field must always be set to an empty object {}.
CurrentCarrierInsightResponse
object
Information about the network the number is currently assigned. This is applicable to mobile numbers only.
5 properties
SubscriberMatchInsightResponse
object
Compare the information associated with a particular mobile phone user with that on file (and verified) by the mobile phone user's Operator and trusted third-p…
13 properties
OriginalCarrierInsightRequest
object
Request the originalcarrier insight. This field must always be set to an empty object {}.
MatchResult
string
LocationVerificationInsightRequest
object
Request the locationverification insight.
1 property
BaseStatus
object
Indicates the status of the information returned for the specified phone number.
2 properties
DeviceSwapInsightResponse
object
Information about any recent physical device change for a mobile phone number. A recent device swap may indicate a potential risk of account takeover.
3 properties
SubscriberMatchInsightRequest
object
Request the subscribermatch insight.
11 properties
ReachabilityInsightRequest
object
Request the reachability insight. This field must always be set to an empty object {}.
AggregatedInsightResponse
object
2 properties
RoamingInsightResponse
object
Check roaming status and country for a given device on a mobile network.
4 properties
FormatInsightRequest
object
Request the format insight. This field must always be set to an empty object {}.
ReachabilityInsightResponse
object
Check the connectivity status for a given device, including if it is connected to the newtork for data, SMS, or both.
4 properties
SimSwapInsightResponse
object
Information about any recent SIM pairing changes related to a mobile account. A recent SIM swap may indicate a potential risk of account takeover.
3 properties
SubscriberMatchStatusCode
string
Code indicating the status of the request. This enum is extensible; clients must handle unknown values.
SubscriberMatchStatus
DeviceSwapInsightRequest
object
Request the deviceswap insight.
1 property
SimSwapInsightRequest
object
Request the simswap insight.
1 property
InsightStatus
ErrorResponse
object
Error response
4 properties 2 required
FormatInsightResponse
object
Validates the format of a phone number and provides information based on that format.
9 properties
OriginalCarrierInsightResponse
object
Information about the network the number was initially assigned. Information based on the numbering plan prefix.
5 properties
LocationVerificationInsightResponse
object
Verify whether the location of certain user device is within the area specified.
4 properties
RoamingInsightRequest
object
Request the roaming insight. This field must always be set to an empty object {}.
InsightStatusCode
string
Code indicating the status of the request. This enum is extensible; clients must handle unknown values.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vonage-identity-insights-api-openapi.yml Raw ↑

Other APIs Vonage publishes across the network.

Vonage Account API
Vonage Advanced API
Vonage Application API
Vonage Applications API
Vonage Archives API
Vonage Audio Connector API
Vonage Balance API
Vonage Basic API
Vonage Broadcast API
Vonage Calls API
Vonage Configuration API
Vonage Conversation API
Where this information came from

This is an independent, third-party profile of Vonage Identity Insights API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.