What format should phone numbers be in to use the Phone Number Lookup API?

Phone numbers should be in the E.164 format to use the Phone Number Lookup API.

What information can I get from the Phone Number Lookup API?

You can get information about the carrier, portability status, and potential fraud detection related to a phone number.

How does the API detect fraud?

The API detects potential fraudulent activity linked to the phone number.

What is the rate limit for the Phone Number Lookup API?

The rate limit is 15 requests per 60 seconds, and it is multi-region.

What is the base URL for accessing the Phone Number Lookup API?

The base URL for accessing the Phone Number Lookup API is `https://www.sent.dm/api`.

What is the endpoint for performing a phone number lookup?

The endpoint for performing a phone number lookup is `GET /phone-lookup`.

What parameters are required for the phone number lookup request?

The required parameter for the phone number lookup request is `phone`, which must be in E.164 format.

What happens if I exceed the rate limit of the API?

If you exceed the rate limit, you will receive a `429 Too Many Requests` error.

What does a 400 Bad Request error mean in this API?

A 400 Bad Request error means that the phone number format is incorrect.

What should I do if I receive a 500 Internal Server Error?

If you receive a 500 Internal Server Error, it means there was an internal issue processing the request.

Can the API provide information about the carrier name?

Yes, the API can provide the carrier name and other related details.

What is the E.164 format?

E.164 is an international standard for phone number formatting, which includes the country code followed by the phone number.

Is the API capable of checking if a phone number has been ported?

Yes, the API can check if a phone number has been ported to a different carrier.

Does the API provide information on the type of network a phone number is using?

Yes, the API provides information on the network type, like whether it is mobile or fixed line.

What is the response format of a successful phone lookup?

A successful phone lookup returns a JSON object with detailed phone number information such as carrier, portability, and fraud status.

How can I learn more about the E.164 phone number format?

You can learn more about the E.164 format by visiting the official E.164 documentation from ITU.

What does the 'valid_number' field indicate in the API response?

The 'valid_number' field indicates whether the phone number is valid.

Does the API provide the geographical location of the phone number?

Yes, the API provides information on the city and state associated with the phone number.

What should I do if I encounter an error while using the Phone Number Lookup API?

If you encounter an error, check the error message for guidance, ensure the phone number is in E.164 format, and verify you haven't exceeded the rate limit.

Does the Phone Number Lookup API support international phone numbers?

Yes, the API supports international phone numbers as long as they are in the E.164 format.

What carrier details does the Phone Number Lookup API provide?

The API provides carrier details such as the service provider's name, mobile country code (MCC), and mobile network code (MNC).

How accurate is the fraud detection feature of the Phone Number Lookup API?

The fraud detection feature identifies potential fraudulent activity linked to a phone number, helping you assess risk. The accuracy may vary based on several factors.

Can the API determine if a phone number is a mobile or landline number?

Yes, the API provides information on the line type, indicating whether the phone number is mobile or landline.

What does the 'portability' section in the API response include?

The 'portability' section includes information like the Local Routing Number (LRN), ported status, ported date, and originating carrier name.

Is there a limit to the length of the phone number that can be used with the API?

Yes, the phone number in E.164 format must match the pattern ^\+[1-9]\d{1,14}$, meaning it should be no more than 15 digits including the country code.

What is the purpose of the 'national_format' field in the API response?

The 'national_format' field provides the phone number formatted according to the conventions of its country of origin.

How can I use the Phone Number Lookup API to improve data quality?

You can use the API to validate phone numbers, identify potential fraud, and enrich your data with carrier and portability information.

Does the API provide details about the original carrier of a ported number?

Yes, the API provides details about the original carrier (OCN) of a ported number, as well as the current carrier.

Can I use the Phone Number Lookup API for bulk phone number validation?

The API is designed for single phone number lookups, and rate limits apply. Contact support for high-volume use cases.

Phone Number Lookup API

Q: What is the Phone Number Lookup API used for?

The Phone Number Lookup API is used to obtain detailed information about phone numbers, including carrier details, portability status, and fraud detection.

Overview

The Phone Number Lookup API is your go-to solution for obtaining detailed information about phone numbers, including carrier details, portability status, and fraud detection. This API supports phone numbers in the E.164 format, ensuring global compatibility.

Key Features

Carrier Information: Identify the service provider and network type.
Fraud Detection: Detect potential fraudulent activity linked to the number.
Portability Status: Check if a number has been ported to a different carrier.

Rate Limit

Multi-region: 15 requests per 60 seconds

API Base URL

https://www.sent.dm/api

API Endpoints

`GET /phone-lookup`

Summary

This endpoint allows you to perform a lookup for a phone number in E.164 format. It returns comprehensive data including carrier, portability, and fraud status.

Request Parameters

Parameter	In	Required	Type	Description
`phone`	query	true	string	The phone number in E.164 format (e.g., `+12345678900`). Must match the pattern: `^\+[1-9]\d{1,14}$`

Response

200 OK

A successful response includes detailed phone number information.

{
  "data": {
    "country_code": "US",
    "national_format": "(234) 567-8900",
    "phone_number": "+12345678900",
    "fraud": null,
    "carrier": {
      "mobile_country_code": "221",
      "mobile_network_code": "01",
      "name": "PTK sh.a./Vala",
      "type": "mobile",
      "error_code": null,
      "normalized_carrier": ""
    },
    "caller_name": null,
    "nnid_override": null,
    "portability": {
      "lrn": "234567XXXX",
      "ported_status": "",
      "ported_date": null,
      "ocn": "6959",
      "line_type": "mobile",
      "spid": "",
      "spid_carrier_name": "CELLCO PARTNERSHIP DBA VERIZON",
      "spid_carrier_type": "",
      "altspid": "",
      "altspid_carrier_name": "",
      "altspid_carrier_type": "",
      "city": "MAHOPAC",
      "state": "New York"
    },
    "valid_number": true,
    "record_type": "number_lookup"
  },
  "poweredBy": "Powered by Sent.dm - [Visit Sent.dm](https://www.sent.dm)"
}

Error Responses

400 Bad Request

Occurs when the phone number format is incorrect.

{
  "error": "Invalid phone number format. Must be in E.164 format."
}

429 Too Many Requests

Triggered when the rate limit is exceeded.

{
  "error": "Rate limit exceeded. Please wait and try again."
}

500 Internal Server Error

Returned when there is an internal error processing the request.

{
  "error": "Failed to retrieve phone data."
}

For more information on the E.164 format, visit the official E.164 documentation.