[**Documentation**](index.md) *** [Documentation](packages.md) / Vonage JWT # Vonage Number Insights SDK for Node.js ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vonage/vonage-node-sdk/ci.yml?branch=3.x) [![Codecov](https://img.shields.io/codecov/c/github/vonage/vonage-node-sdk?label=Codecov&logo=codecov&style=flat-square)](https://codecov.io/gh/Vonage/vonage-server-sdk) ![Latest Release](https://img.shields.io/npm/v/@vonage/number-insights?label=%40vonage%2Fnumber-insights&style=flat-square) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-square)](../../CODE_OF_CONDUCT.md) [![License](https://img.shields.io/npm/l/@vonage/accounts?label=License&style=flat-square)][license] Vonage This is the Vonage Number Insights SDK for Node.js for use with [Vonage APIs](https://www.vonage.com/). To use it you will need a Vonage account. Sign up [for free at vonage.com][signup]. For full API documentation refer to [developer.nexmo.com](https://developer.nexmo.com/). If you are updating from V2 to V3, please check the migration guide found [here](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/number-insights/v2_TO_v3_MIGRATION_GUIDE.md) * [Installation](#installation) * [Usage](#usage) * [Promises](#promises) * [Testing](#testing) ## Installation We recommend using this SDK as part of the overall [`@vonage/server-sdk` package](https://github.com/vonage/vonage-node-sdk). Please see the main package for installation. You can also use this SDK standalone if you only need access to just the Messages API. ### With NPM ```bash npm install @vonage/number-insights ``` ### With Yarn ```bash yarn add @vonage/number-insights ``` ## Usage ### As part of the Vonage Server SDK If you are using this SDK as part of the Vonage Server SDK, you can access it as the `messages` property off of the client that you instantiate. ```js const { Auth } = require('@vonage/auth'); const { Vonage } = require('@vonage/server-sdk'); const credentials = new Auth({ apiKey: API_KEY, apiSecret: API_SECRET }); const options = {}; const vonage = new Vonage(credentials, options); vonage.numberInsights.basicLookup(PHONE_NUMBER) .then(resp => console.log(resp)) .catch(err => console.error(err)); ``` ### Standalone The SDK can be used standalone from the main [Vonage Server SDK for Node.js](https://github.com/vonage/vonage-node-sdk) if you only need to use the Messages API. All you need to do is `require('@vonage/number-insights')`, and use the returned object to create your own client. ```js const { Auth } = require('@vonage/auth'); const { NumberInsights } = require('@vonage/number-insights'); const credentials = new Auth({ apiKey: API_KEY, apiSecret: API_SECRET }); const options = {}; const niClient = new NumberInsights(credentials, options); ``` Where `credentials` is any option from [`@vonage/auth`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/auth/README.md#options), and `options` is any option from [`@vonage/server-client`](https://github.com/Vonage/vonage-node-sdk/blob/3.x/packages/server-client/README.md#options) ## Promises Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use `await` to wait for a response. ```js const resp = await vonage.numberInsights.basicLookup(PHONE_NUMBER) vonage.numberInsights.basicLookup(PHONE_NUMBER) .then(resp => console.log(resp)) .catch(err => console.error(err)); ``` ## Testing Run: ```bash npm run test ``` [signup]: https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=node-server-sdk [license]: _media/LICENSE.txt ## Enumerations ### CallerType Defined in: [number-insights/lib/enums/CallerType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/CallerType.ts#L4) Enum representing the type of caller for a phone number. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `BUSINESS` | `"business"` | The value will be "business" if the owner of a phone number is a business. | [number-insights/lib/enums/CallerType.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/CallerType.ts#L13) | | `CONSUMER` | `"consumer"` | The value will be "consumer" if the owner of a phone number is an individual. | [number-insights/lib/enums/CallerType.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/CallerType.ts#L18) | | `UNKNOWN` | `"unknown"` | The value will be "unknown" if the information about the caller type is not available. | [number-insights/lib/enums/CallerType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/CallerType.ts#L8) | *** ### LookupOutcome Defined in: [number-insights/lib/enums/LookupOutcome.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/LookupOutcome.ts#L4) Enum representing the outcomes of a lookup operation. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `FAILED` | `2` | The lookup operation failed. | [number-insights/lib/enums/LookupOutcome.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/LookupOutcome.ts#L18) | | `PARTIAL_SUCCESS` | `1` | The lookup operation partially succeeded. | [number-insights/lib/enums/LookupOutcome.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/LookupOutcome.ts#L13) | | `SUCCESS` | `0` | The lookup operation was successful. | [number-insights/lib/enums/LookupOutcome.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/LookupOutcome.ts#L8) | *** ### NetworkType Defined in: [number-insights/lib/enums/NetworkType.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L4) Enum representing the type of network associated with a phone number. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `LANDLINE` | `"landline"` | The phone number is associated with a landline network. | [number-insights/lib/enums/NetworkType.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L13) | | `LANDLINE_PREMIUM` | `"landline_premium"` | The phone number is associated with a premium landline network. | [number-insights/lib/enums/NetworkType.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L18) | | `LANDLINE_TOLLFREE` | `"landline_tollfree"` | The phone number is associated with a toll-free landline network. | [number-insights/lib/enums/NetworkType.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L23) | | `MOBILE` | `"mobile"` | The phone number is associated with a mobile network. | [number-insights/lib/enums/NetworkType.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L8) | | `PAGER` | `"pager"` | The phone number is associated with a pager network. | [number-insights/lib/enums/NetworkType.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L38) | | `UNKNOWN` | `"unknown"` | The type of network associated with the phone number is unknown. | [number-insights/lib/enums/NetworkType.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L33) | | `VIRTUAL` | `"virtual"` | The phone number is associated with a virtual network. | [number-insights/lib/enums/NetworkType.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/NetworkType.ts#L28) | *** ### Reachable Defined in: [number-insights/lib/enums/Reachable.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/Reachable.ts#L4) Enum representing the reachability status of a phone number. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `ABSENT` | `"absent"` | The phone number's owner is absent. | [number-insights/lib/enums/Reachable.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/Reachable.ts#L23) | | `BAD_NUMBER` | `"bad_number"` | The phone number is invalid or a bad number. | [number-insights/lib/enums/Reachable.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/Reachable.ts#L28) | | `BLACKLISTED` | `"blacklisted"` | The phone number is blacklisted. | [number-insights/lib/enums/Reachable.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/Reachable.ts#L33) | | `REACHABLE` | `"reachable"` | The phone number is reachable. | [number-insights/lib/enums/Reachable.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/Reachable.ts#L13) | | `UNDELIVERABLE` | `"undeliverable"` | The phone number is undeliverable. | [number-insights/lib/enums/Reachable.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/Reachable.ts#L18) | | `UNKNOWN` | `"unknown"` | The reachability status is unknown. | [number-insights/lib/enums/Reachable.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/Reachable.ts#L8) | *** ### ValidNumber Defined in: [number-insights/lib/enums/ValidNumber.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/ValidNumber.ts#L4) Enum representing the validity status of a phone number. #### Enumeration Members | Enumeration Member | Value | Description | Defined in | | ------ | ------ | ------ | ------ | | `INFERRED` | `"inferred"` | The validity of the phone number is inferred. | [number-insights/lib/enums/ValidNumber.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/ValidNumber.ts#L23) | | `INFERRED_NOT_VALID` | `"inferred_not_valid"` | The inferred validity of the phone number is not valid. | [number-insights/lib/enums/ValidNumber.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/ValidNumber.ts#L28) | | `NOT_VALID` | `"not_valid"` | The phone number is not valid. | [number-insights/lib/enums/ValidNumber.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/ValidNumber.ts#L18) | | `UNKNOWN` | `"unknown"` | The validity status is unknown. | [number-insights/lib/enums/ValidNumber.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/ValidNumber.ts#L8) | | `VALID` | `"valid"` | The phone number is valid. | [number-insights/lib/enums/ValidNumber.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/enums/ValidNumber.ts#L13) | ## Classes ### NumberInsights Defined in: [number-insights/lib/number-insights.ts:41](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/number-insights.ts#L41) Client for the Vonage Number Insights API. #### Examples Create a standalone Number Insight client ```ts import { NumberInsights } from '@vonage/numberInsight'; const numberInsightClient = new NumberInsights({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); ``` Create an Number Insight client from the Vonage client ```ts import { Vonage } from '@vonage/server-client'; const vonage = new Vonage({ apiKey: VONAGE_API_KEY, apiSecret: VONAGE_API_SECRET }); const numberInsightClient = vonage.numberInsight; ``` #### Extends - [`Client`](Vonage-Server-Client.md#client) #### Constructors ##### Constructor ```ts new NumberInsights(credentials, options?): NumberInsights; ``` Defined in: server-client/dist/lib/client.d.ts:35 Creates a new instance of the Client. ###### Parameters ###### credentials The authentication credentials or an authentication instance. [`AuthInterface`](Vonage-Auth.md#authinterface) | [`AuthParams`](Vonage-Auth.md#authparams) ###### options? [`ConfigParams`](Vonage-Server-Client.md#configparams) Optional configuration settings for the client. ###### Returns [`NumberInsights`](#numberinsights) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`constructor`](Vonage-Server-Client.md#client#constructor) #### Properties ##### auth ```ts protected auth: AuthInterface; ``` Defined in: server-client/dist/lib/client.d.ts:24 The authentication instance responsible for generating authentication headers and query parameters. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`auth`](Vonage-Server-Client.md#client#auth) ##### authType ```ts protected authType: AuthenticationType = AuthenticationType.BASIC; ``` Defined in: [number-insights/lib/number-insights.ts:45](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/number-insights.ts#L45) ###### See [Client.authType](Vonage-Messages.md#messages#authtype) ###### Overrides [`Client`](Vonage-Server-Client.md#client).[`authType`](Vonage-Server-Client.md#client#authtype) ##### config ```ts protected config: ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:28 Configuration settings for the client, including default hosts for various services and other request settings. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`config`](Vonage-Server-Client.md#client#config) ##### transformers ```ts static transformers: object; ``` Defined in: server-client/dist/lib/client.d.ts:11 Static property containing utility transformers. ###### camelCaseObjectKeys ```ts camelCaseObjectKeys: PartialTransformFunction; ``` ###### kebabCaseObjectKeys ```ts kebabCaseObjectKeys: PartialTransformFunction; ``` ###### omit() ```ts omit: (keys, obj) => TransformedObject; ``` ###### Parameters ###### keys `string`[] ###### obj [`ObjectToTransform`](Vonage-Server-Client.md#objecttotransform) ###### Returns [`TransformedObject`](Vonage-Server-Client.md#transformedobject) ###### snakeCaseObjectKeys ```ts snakeCaseObjectKeys: PartialTransformFunction; ``` ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`transformers`](Vonage-Server-Client.md#client#transformers) #### Methods ##### addAuthenticationToRequest() ```ts addAuthenticationToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:43 Adds the appropriate authentication headers or parameters to the request based on the authentication type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addAuthenticationToRequest`](Vonage-Server-Client.md#client#addauthenticationtorequest) ##### addBasicAuthToRequest() ```ts protected addBasicAuthToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:71 Adds basic authentication headers to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addBasicAuthToRequest`](Vonage-Server-Client.md#client#addbasicauthtorequest) ##### addJWTToRequest() ```ts protected addJWTToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:64 Adds a JWT to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addJWTToRequest`](Vonage-Server-Client.md#client#addjwttorequest) ##### addQueryKeySecretToRequest() ```ts protected addQueryKeySecretToRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:57 Adds API key and secret to the request. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequest`](Vonage-Server-Client.md#client#addquerykeysecrettorequest) ##### addQueryKeySecretToRequestBody() ```ts protected addQueryKeySecretToRequestBody(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:50 Adds API key and secret to the request body. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options to which authentication needs to be added. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The request options with the added authentication. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`addQueryKeySecretToRequestBody`](Vonage-Server-Client.md#client#addquerykeysecrettorequestbody) ##### advancedLookup() ```ts advancedLookup(phoneNumber, options?): Promise; ``` Defined in: [number-insights/lib/number-insights.ts:60](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/number-insights.ts#L60) Perform an advanced number lookup operation. ###### Parameters ###### phoneNumber `string` The phone number to perform the lookup for. ###### options? [`AdvancedLookupOptions`](#advancedlookupoptions) Additional options for the lookup. ###### Returns `Promise`\<[`AdvancedResponse`](#advancedresponse)\> A promise that resolves to the advanced lookup response. ###### Example ```ts const lookup = await numberInsightsClient.advancedLookup('15555551212'); console.log(`Ths number is ${lookup.valid_number}`); ``` ##### asyncAdvancedLookup() ```ts asyncAdvancedLookup( phoneNumber, callback, options?): Promise; ``` Defined in: [number-insights/lib/number-insights.ts:100](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/number-insights.ts#L100) Perform an asynchronous advanced number lookup operation. ###### Parameters ###### phoneNumber `string` The phone number to perform the lookup for. ###### callback `string` The callback URL for receiving the async lookup response. ###### options? [`StandardLookupOptions`](#standardlookupoptions) Additional options for the lookup. ###### Returns `Promise`\<[`AsyncAdvancedResponse`](#asyncadvancedresponse)\> A promise that resolves to the async advanced lookup response. ###### Examples ```ts const lookup = await numberInsightsClient.asyncAdvancedLookup( '15555551212', 'https://example.com/number-insights', ); console.log(`The request ID is ${lookup.request_id}`); ``` Lookup with the CNAME option: ```ts const lookup = await numberInsightsClient.asyncAdvancedLookup( '15555551212', 'https://example.com/number-insights', { cname: true }, ); console.log(`The request ID is ${lookup.request_id}`); ``` ##### basicLookup() ```ts basicLookup(phoneNumber, options?): Promise; ``` Defined in: [number-insights/lib/number-insights.ts:138](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/number-insights.ts#L138) Perform a basic number lookup operation. ###### Parameters ###### phoneNumber `string` The phone number to perform the lookup for. ###### options? [`BasicLookupOptions`](#basiclookupoptions) Additional options for the lookup. ###### Returns `Promise`\<[`BasicResponse`](#basicresponse)\> A promise that resolves to the basic lookup response. ###### Examples ```ts const lookup = await numberInsightsClient.basicLookup( '15555551212', ); console.log(`The request ID is ${lookup.request_id}`); ``` Lookup with the country option: ```ts const lookup = await numberInsightsClient.basicLookup( '15555551212', { country: 'US' }, ); console.log(`The request ID is ${lookup.request_id}`); ``` ##### getConfig() ```ts getConfig(): ConfigParams; ``` Defined in: server-client/dist/lib/client.d.ts:36 ###### Returns [`ConfigParams`](Vonage-Server-Client.md#configparams) ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`getConfig`](Vonage-Server-Client.md#client#getconfig) ##### parseResponse() ```ts protected parseResponse(request, response): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:168 Parses the response based on its content type. ###### Type Parameters ###### T `T` The expected type of the parsed response data. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### response `Response` The raw response from the request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`parseResponse`](Vonage-Server-Client.md#client#parseresponse) ##### prepareBody() ```ts protected prepareBody(request): undefined | string; ``` Defined in: server-client/dist/lib/client.d.ts:158 Prepares the body for the request based on the content type. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The request options. ###### Returns `undefined` \| `string` - The prepared request body as a string or undefined. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareBody`](Vonage-Server-Client.md#client#preparebody) ##### prepareRequest() ```ts protected prepareRequest(request): Promise; ``` Defined in: server-client/dist/lib/client.d.ts:151 Prepares the request with necessary headers, authentication, and query parameters. ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The initial request options. ###### Returns `Promise`\<[`VetchOptions`](Vonage-Vetch.md#vetchoptions)\> - The modified request options. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`prepareRequest`](Vonage-Server-Client.md#client#preparerequest) ##### sendDeleteRequest() ```ts sendDeleteRequest(url): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:78 Sends a DELETE request to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the DELETE request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the DELETE request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendDeleteRequest`](Vonage-Server-Client.md#client#senddeleterequest) ##### sendFormSubmitRequest() ```ts sendFormSubmitRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:86 Sends a POST request with form data to the specified URL. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? `Record`\<`string`, `undefined` \| `string`\> Optional payload containing form data to send with the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendFormSubmitRequest`](Vonage-Server-Client.md#client#sendformsubmitrequest) ##### sendGetRequest() ```ts sendGetRequest(url, queryParams?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:94 Sends a GET request to the specified URL with optional query parameters. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the GET request. ###### queryParams? Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the GET request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendGetRequest`](Vonage-Server-Client.md#client#sendgetrequest) ##### sendPatchRequest() ```ts sendPatchRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:104 Sends a PATCH request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PATCH request. ###### payload? Optional payload to be sent as the body of the PATCH request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PATCH request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPatchRequest`](Vonage-Server-Client.md#client#sendpatchrequest) ##### sendPostRequest() ```ts sendPostRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:114 Sends a POST request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the POST request. ###### payload? Optional payload to be sent as the body of the POST request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the POST request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPostRequest`](Vonage-Server-Client.md#client#sendpostrequest) ##### sendPutRequest() ```ts sendPutRequest(url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:124 Sends a PUT request to the specified URL with an optional payload. ###### Type Parameters ###### T `T` ###### Parameters ###### url `string` The URL endpoint for the PUT request. ###### payload? Optional payload to be sent as the body of the PUT request. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the PUT request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendPutRequest`](Vonage-Server-Client.md#client#sendputrequest) ##### sendRequest() ```ts sendRequest(request): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:144 Sends a request adding necessary headers, handling authentication, and parsing the response. ###### Type Parameters ###### T `T` ###### Parameters ###### request [`VetchOptions`](Vonage-Vetch.md#vetchoptions) The options defining the request, including URL, method, headers, and data. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The parsed response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequest`](Vonage-Server-Client.md#client#sendrequest) ##### sendRequestWithData() ```ts sendRequestWithData( method, url, payload?): Promise>; ``` Defined in: server-client/dist/lib/client.d.ts:135 Sends a request with JSON-encoded data to the specified URL using the provided HTTP method. ###### Type Parameters ###### T `T` ###### Parameters ###### method The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable). [`POST`](Vonage-Vetch.md#httpmethods#post) | [`PUT`](Vonage-Vetch.md#httpmethods#put) | [`PATCH`](Vonage-Vetch.md#httpmethods#patch) ###### url `string` The URL endpoint for the request. ###### payload? Optional payload to be sent as the body of the request, JSON-encoded. ###### Returns `Promise`\<[`VetchResponse`](Vonage-Vetch.md#vetchresponse)\<`T`\>\> - The response from the request. ###### Inherited from [`Client`](Vonage-Server-Client.md#client).[`sendRequestWithData`](Vonage-Server-Client.md#client#sendrequestwithdata) ##### standardLookup() ```ts standardLookup(phoneNumber, options?): Promise; ``` Defined in: [number-insights/lib/number-insights.ts:175](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/number-insights.ts#L175) Perform a standard number lookup operation. ###### Parameters ###### phoneNumber `string` The phone number to perform the lookup for. ###### options? [`StandardLookupOptions`](#standardlookupoptions) Additional options for the lookup. ###### Returns `Promise`\<[`StandardResponse`](#standardresponse)\> A promise that resolves to the standard lookup response. ###### Examples ```ts const lookup = await numberInsightsClient.standardLookup( '15555551212', ); console.log(`The request ID is ${lookup.request_id}`); ``` Lookup with the cname option: ```ts const lookup = await numberInsightsClient.standardLookup( '15555551212', { cname: true }, ); console.log(`The request ID is ${lookup.request_id}`); ``` ## Type Aliases ### AdvancedLookupOptions ```ts type AdvancedLookupOptions = StandardLookupOptions & object; ``` Defined in: [number-insights/lib/types/AdvancedLookupOptions.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/AdvancedLookupOptions.ts#L6) Interface representing advanced lookup options for a phone number lookup operation. #### Type declaration ##### real\_time\_data? ```ts optional real_time_data: boolean; ``` Indicates whether real-time data should be included in the lookup. If `true`, real-time data is included; otherwise, it's not included. *** ### AdvancedResponse ```ts type AdvancedResponse = StandardResponse & object; ``` Defined in: [number-insights/lib/types/Responses/AdvancedResponse.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AdvancedResponse.ts#L18) Type representing an advanced response from a phone number lookup operation. #### Type declaration ##### lookup\_outcome ```ts lookup_outcome: LookupOutcome; ``` The outcome of the lookup operation, represented by a `LookupOutcome` enum value. ##### lookup\_outcome\_message ```ts lookup_outcome_message: string; ``` A message describing the outcome of the lookup operation. ##### reachable ```ts reachable: Reachable; ``` The reachability status of the phone number, represented by a `Reachable` enum value. ##### real\_time\_data ```ts real_time_data: RealTimeDataResponse; ``` Real-time data related to the phone number. ##### roaming ```ts roaming: RoamingDataResponse | string; ``` Information about the roaming status of the phone number. ##### valid\_number ```ts valid_number: ValidNumber; ``` The validity status of the phone number, represented by a `ValidNumber` enum value. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. *** ### AsyncAdvancedLookupOptions ```ts type AsyncAdvancedLookupOptions = StandardLookupOptions & object; ``` Defined in: [number-insights/lib/types/AsyncAdvancedLookupOptions.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/AsyncAdvancedLookupOptions.ts#L6) Interface representing asynchronous advanced lookup options for a phone number lookup operation. #### Type declaration ##### callback ```ts callback: string; ``` The callback URL to which the lookup response will be sent asynchronously. *** ### AsyncAdvancedResponse ```ts type AsyncAdvancedResponse = object; ``` Defined in: [number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AsyncAdvancedResponse.ts#L9) Type representing an asynchronous advanced response from a phone number lookup operation. This response may include additional details about the request and its status. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### error\_text ```ts error_text: string; ``` Defined in: [number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:38](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AsyncAdvancedResponse.ts#L38) Any error text or message associated with the response. ##### number ```ts number: string; ``` Defined in: [number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AsyncAdvancedResponse.ts#L18) The phone number associated with the response. ##### remaining\_balance ```ts remaining_balance: string; ``` Defined in: [number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:23](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AsyncAdvancedResponse.ts#L23) Your account balance in EUR after this request. ##### request\_id ```ts request_id: string; ``` Defined in: [number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:13](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AsyncAdvancedResponse.ts#L13) The unique identifier for the request. ##### request\_price ```ts request_price: string; ``` Defined in: [number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:28](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AsyncAdvancedResponse.ts#L28) The amount in EUR charged to your account for this request. ##### status ```ts status: number; ``` Defined in: [number-insights/lib/types/Responses/AsyncAdvancedResponse.ts:33](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/AsyncAdvancedResponse.ts#L33) The status code of the response. *** ### BasicLookupOptions ```ts type BasicLookupOptions = object; ``` Defined in: [number-insights/lib/types/BasicLookupOptions.ts:4](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/BasicLookupOptions.ts#L4) Basic lookup options for a phone number lookup operation. #### Properties ##### country? ```ts optional country: string; ``` Defined in: [number-insights/lib/types/BasicLookupOptions.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/BasicLookupOptions.ts#L8) The two-character country code for the phone number's country. *** ### BasicResponse ```ts type BasicResponse = object; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L8) Type representing a basic response from a phone number lookup operation. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### country\_code ```ts country_code: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:37](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L37) The two-character country code for the phone number. ##### country\_code\_iso3 ```ts country_code_iso3: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:42](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L42) The three-character country code for the phone number. ##### country\_name ```ts country_name: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:47](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L47) The full name of the country that the phone number is registered in. ##### country\_prefix ```ts country_prefix: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:52](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L52) The numeric prefix for the country that the phone number is registered in. ##### international\_format\_number ```ts international_format_number: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:27](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L27) The phone number in international format. ##### national\_format\_number ```ts national_format_number: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:32](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L32) The phone number in the format used by the country. ##### request\_id ```ts request_id: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:22](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L22) The unique identifier for the request. ##### status ```ts status: number; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L12) The status code of the response. ##### status\_message ```ts status_message: string; ``` Defined in: [number-insights/lib/types/Responses/BasicResponse.ts:17](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/BasicResponse.ts#L17) The status message of the response. *** ### CallerIdentityResponse ```ts type CallerIdentityResponse = object; ``` Defined in: [number-insights/lib/types/Responses/CallerIdentityResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CallerIdentityResponse.ts#L10) Type representing the identity of a caller. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### caller\_name ```ts caller_name: string; ``` Defined in: [number-insights/lib/types/Responses/CallerIdentityResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CallerIdentityResponse.ts#L15) The caller's name. ##### caller\_type ```ts caller_type: CallerType; ``` Defined in: [number-insights/lib/types/Responses/CallerIdentityResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CallerIdentityResponse.ts#L12) The type of the caller, either "business," "consumer," or "unknown." ##### first\_name ```ts first_name: string; ``` Defined in: [number-insights/lib/types/Responses/CallerIdentityResponse.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CallerIdentityResponse.ts#L18) The caller's first name. ##### last\_name ```ts last_name: string; ``` Defined in: [number-insights/lib/types/Responses/CallerIdentityResponse.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CallerIdentityResponse.ts#L21) The caller's last name. *** ### CarrierInfoResponse ```ts type CarrierInfoResponse = object; ``` Defined in: [number-insights/lib/types/Responses/CarrierInforResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CarrierInforResponse.ts#L10) Type representing carrier information. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### country ```ts country: string; ``` Defined in: [number-insights/lib/types/Responses/CarrierInforResponse.ts:18](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CarrierInforResponse.ts#L18) The country in which the carrier operates. ##### name ```ts name: string; ``` Defined in: [number-insights/lib/types/Responses/CarrierInforResponse.ts:15](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CarrierInforResponse.ts#L15) The full name of the carrier. ##### network\_code ```ts network_code: string; ``` Defined in: [number-insights/lib/types/Responses/CarrierInforResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CarrierInforResponse.ts#L12) The network code associated with the carrier. ##### network\_type ```ts network_type: NetworkType; ``` Defined in: [number-insights/lib/types/Responses/CarrierInforResponse.ts:21](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/CarrierInforResponse.ts#L21) The type of network associated with the carrier. *** ### NumberInsightsResponse\ ```ts type NumberInsightsResponse = VetchResponse; ``` Defined in: [number-insights/lib/types/NumberInsightsResponse.ts:7](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/NumberInsightsResponse.ts#L7) Interface representing a response from a number insights operation. This extends the `VetchResponse` interface. #### Type Parameters ##### T `T` *** ### ~~RealTimeDataResponse~~ ```ts type RealTimeDataResponse = object; ``` Defined in: [number-insights/lib/types/Responses/RealTimeDataResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RealTimeDataResponse.ts#L10) Type representing real-time data related to a phone number. #### Deprecated This service will be removed #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### ~~active\_status~~ ```ts active_status: string; ``` Defined in: [number-insights/lib/types/Responses/RealTimeDataResponse.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RealTimeDataResponse.ts#L11) ##### ~~handset\_status~~ ```ts handset_status: string; ``` Defined in: [number-insights/lib/types/Responses/RealTimeDataResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RealTimeDataResponse.ts#L12) *** ### RoamingDataResponse ```ts type RoamingDataResponse = object; ``` Defined in: [number-insights/lib/types/Responses/RoamingDataResponse.ts:8](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RoamingDataResponse.ts#L8) Type representing information about the roaming status of a phone number. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`. #### Properties ##### roaming\_country\_code ```ts roaming_country_code: string; ``` Defined in: [number-insights/lib/types/Responses/RoamingDataResponse.ts:10](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RoamingDataResponse.ts#L10) ##### roaming\_network\_code ```ts roaming_network_code: string; ``` Defined in: [number-insights/lib/types/Responses/RoamingDataResponse.ts:11](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RoamingDataResponse.ts#L11) ##### roaming\_network\_name ```ts roaming_network_name: string; ``` Defined in: [number-insights/lib/types/Responses/RoamingDataResponse.ts:12](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RoamingDataResponse.ts#L12) ##### status ```ts status: string; ``` Defined in: [number-insights/lib/types/Responses/RoamingDataResponse.ts:9](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/RoamingDataResponse.ts#L9) *** ### StandardLookupOptions ```ts type StandardLookupOptions = BasicLookupOptions & object; ``` Defined in: [number-insights/lib/types/StandardLookupOptions.ts:6](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/StandardLookupOptions.ts#L6) Interface representing standard lookup options for a phone number lookup operation. #### Type declaration ##### cname? ```ts optional cname: boolean; ``` Indicates whether caller name (CNAME) information should be included in the lookup. If `true`, CNAME information is included; otherwise, it's not included. *** ### StandardResponse ```ts type StandardResponse = BasicResponse & object; ``` Defined in: [number-insights/lib/types/Responses/StandardResponse.ts:14](https://github.com/Vonage/vonage-node-sdk/blob/3846dd78a7cd39b838839d5c93db0b1652c0d168/packages/number-insights/lib/types/Responses/StandardResponse.ts#L14) Type representing a standard response from a phone number lookup operation. This response includes various details such as pricing, carrier information, porting status, and caller identity. #### Type declaration ##### caller\_identity ```ts caller_identity: CallerIdentityResponse; ``` Information about the caller's identity. ##### caller\_name ```ts caller_name: string; ``` Full name of the person or business who owns the phone number. ##### caller\_type ```ts caller_type: CallerType; ``` The type of caller, either "business," "consumer," or "unknown." ##### country\_code ```ts country_code: string; ``` The two-character country code for the phone number. ##### country\_code\_iso3 ```ts country_code_iso3: string; ``` The three-character country code for the phone number. ##### country\_name ```ts country_name: string; ``` The full name of the country that the phone number is registered in. ##### country\_prefix ```ts country_prefix: string; ``` The numeric prefix for the country that the phone number is registered in. ##### current\_carrier ```ts current_carrier: CarrierInfoResponse; ``` Information about the current carrier of the phone number. ##### first\_name ```ts first_name: string; ``` First name of the person who owns the phone number. ##### international\_format\_number ```ts international_format_number: string; ``` The phone number in international format. ##### last\_name ```ts last_name: string; ``` Last name of the person who owns the phone number. ##### national\_format\_number ```ts national_format_number: string; ``` The phone number in the format used by the country. ##### original\_carrier ```ts original_carrier: CarrierInfoResponse; ``` Information about the original carrier of the phone number. ##### ported ```ts ported: string; ``` Porting status of the phone number. ##### refund\_price ```ts refund_price: string; ``` The refund amount in EUR, reflecting lookup and CNAM pricing. ##### remaining\_balance ```ts remaining_balance: string; ``` Your account balance in EUR after this request. ##### request\_id ```ts request_id: string; ``` The unique identifier for the request. ##### request\_price ```ts request_price: string; ``` The price charged for the request in EUR. ##### status ```ts status: number; ``` The status code of the response. ##### status\_message ```ts status_message: string; ``` The status message of the response. #### Remarks Vonage API's will return information using `snake_case`. This represents the pure response before the client will transform the keys into `camelCase`.