post

/phoneid/{complete_phone_number}

General Requirements

Request Requirements

  • Authentication: Basic (easiest to implement) or Digest
  • Endpoint: https://rest-api.telesign.com/v1/phoneid/{complete_phone_number}
  • Encoding: Accepts only UTF-8 unicode characters as inputs
  • MIME Type: application/json
  • Required Headers: Content-Type

Response Details

  • MIME Type: application/json

Request Parameters

1 Path Parameter

Request Body

Schema
object
account_lifecycle_event
string

The account lifecycle event parameter allows you to send information about what stage an end user was in when you retrieved information about their phone number. Acceptable values for this parameter are -

  • create - For the creation of a new account.
  • sign-in - For when an end user signs in to their account.
  • transact - For when an end user completes a transaction within their account.
  • update - For when an update is performed, such as an update of account information or similar.
  • delete - For when an account is deleted.
1 validation
originating_ip
string

Your end user’s IP address (do not send your own IP address). IPv4 and IPv6 are supported. For IPv4, the value must be in the format defined by the Internet Engineering Task Force (IETF) in the Internet-Draft doucment titled Internet Protocol. For IPv6, the value must be in the format defined by the IETF in the Internet-Draft document titled IP Version 6 Addressing Arcitecture.

1 validation
addons
object

Indicates which add-ons you want to use with this request, and contains any other inputs for use with those add-ons.

Responses

Your request was fulfilled and resulted in a new resource being created. If you want to code against a response, you should retrieve the status or error code and use that rather than the HTTP status response.

Status Code Associated Text String Description
300 Transaction successfully completed The system was able to obtain all of the requested data for PhoneID.
301 Transaction partially completed The system was able to obtain some of the data for PhoneID, but not all of it.
Schema
object
reference_id
string

A 32-digit hex value used to identify this request. The value is unique to each web service request, is randomly generated by TeleSign, and is returned in the response message immediately following the web service request.

1 validation
phone_type
object

Contains details about the phone type.

blocklisting
object

Contains details about whether the number was blocked and who requested the block. To see this information, speak with our Customer Support Team to have blocklisting information enabled.

status
object

Contains details about the status of your request.

numbering
object

Contains details about the numbering attributes of this phone number.

location
object

Contains geographical location information associated with the phone number.

addons
object

Contains properties flagging each PhoneID add-on that you wish to include in processing this request, and extra information for these add-ons (if applicable).

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
complete_phone_number
$$.env
1 variable not set
host