Contact Add-on

The Contact add-on allows you to retrieve the name, address, and other contact info associated with the subscriber for the phone number you submit, without requesting explicit consent from your end user. The information returned by this add-on includes:

  • First Name
  • Last Name
  • Street Address
  • City
  • State (or Province)
  • Country
  • ZIP Code
  • Email Address

Example

This is an example of using the PhoneID API with the Contact add-on.

Request
application/json
POST https://rest-ww.telesign.com/v1/phoneid/15555551212 HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:vjE/ZDfPvDkuGNsuqCFFO4neYIs=
Date: Thu, 12 Oct 2017 14:11:09 GMT
Content-Type: application/json 


{  
		"addons": {
 			"contact": {}
		}
}
Response (body only)
application/json
{
  "contact": {
    "address1": "2432 CHIMNEY POINT LN",
    "address2": "",
    "address3": "",
    "address4": "",
    "city": "LEXINGTON",
    "country": "",
    "first_name": "MYLA",
    "last_name": "JONES",
    "state_province": "KY",
    "status": {
      "code": 2800,
      "description": "Request successfully completed"
    },
    "zip_postal_code": "40509",
    "email_address": "email@acme.com"
  }
}

Request and Response for the Contact Add-on

Contact Request Parameters
object
addons
object

You must have you Technical Account Manager enable this feature for use. The addons parameter allows you to receive information returned from Contact, Contact Plus, Contact Match, or Number Deactivation, depending on which add-ons you enable. You receive add-on information back along with standard PhoneID information.

Contact Response
object
reference_id
string

A 32-digit hex value used to identify the web service requests. 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.

phone_type
string

One of the phone type codes.

description
string

Text describing the phone type.

contact
object

You will only see this in your response if you used the contact add-on.