Skip to main content
API Integration - Phone Number

Learn how to validate your customer phone number via our API service

Ryan Haidinger avatar
Written by Ryan Haidinger
Updated over a week ago

Overview

This guide will help you validate customer phone numbers individually via our API service. Our service will indicate if the phone number is valid, type of number, and any underlying details.

To access our API documentation, please click here


Base URL

Body

There are two parameters allowed within the request Body:

  • order_id - this is optional, but recommended if you're validating an eCommerce based order.

  • phone_number

Responses

Based on the phone number provided, our API will respond with a series of results including an in-depth overview of the number details and relevant type information to help your brand reduce wasted SMS related costs. The below table provides a description of each of these values:

Name

Example

Description

Validation Code

1000

Internal value related to the validation text.

Validation Text

The provided phone is valid

Detailed description of the related validation code.

Valid Number

true

If the phone number is genuine and can receive data.

Location

United States

Registration location of the phone number.

Carrier

Verizon

The carrier name that provides service to this phone number.

Line Type

Mobile

The type of phone number, such as Mobile or Landline.


Have a Question?

Be sure to ask our team via the Live Chat button on the bottom right, or contact your account manager directly via email / phone to learn more.

Did this answer your question?