Previous Page

FREE API KEY

*Fields required.

Tutorials

Phone Verify Tutorial

Overview

Phone Verification is a real-time solution where a match-back of a person and their phone number is performed and the person’s associated phone numbers are returned, if their input phone matches the one in the database that is returned, then the phone is considered verified.

Phone Verify URI

The Phone Verify URI accepts a person’s name, address, and phone number. The phone information is then returned by the URI if the person provided in the request is the owner of the phone number.

Required Information

The Phone Verify URI requires you to have an Authorization Token. If you have not retrieved an Authorization Token yet, follow the Authorization Tutorial before continuing.

The Phone Verify URI, like all of the solution URIs, also requires you to have an API Key. If you do not know your API Key, contact support to retrieve it. The API Key should be provided in the request header with the header attribute: x-api-key

The Phone Verify URI must be used with a POST request, where the request payload contains the person’s name, address and phone number.

Example
Request URL

The URL for the Phone Verify URI is: https://api.thedatagroup.com/{version}/sync/verify/phone, where {version} is the API Version you wish to use.

Request Headers
Header Attribute Header Value
x-api-key {your api key}
AuthorizationToken {your authorization token}
Content-Type application/json
Request Payload

The request payload for the Phone Verify URI must contain the first_name , last_name, address_1, and the phone attributes. It must also contain either the zipcode attribute or both the city and state attributes.

{ “phone”: “5555550123”, “first_name”: “John”, "last_name”: “Smith”, “address_1”: “425 S. Avalon Park BLVD”, “zipcode”: “32828” }
cURL Example

To query the Phone Verify URI, you can use one of the provided SDKs, a REST Client, or a simple cURL command. Below is an example of the cURL command for the example input information.

curl -X POST -H "AuthorizationToken: {your token here}" -H "x-api-key: {your key here}" -H "Content-Type: application/json" -d '{ “phone”: “5555550123”, “first_name”: “John”, "last_name”: “Smith”, “address_1”: “425 S. Avalon Park BLVD”, “zipcode”: “32828” }' " https://api.thedatagroup.com/v3/sync/verify/phone"
Response Payload

The response payload for the Phone Verify URI will contain the information for the person who owns the verified phone number, as well as their address information. If the phone number cannot be verified, a 400 Error Code will be returned instead of the payload.

{ address : { zipcode: “32828”, unit_number: “425”, city: “ORLANDO”, post_direction: “N”, street_number: “1234”, pre_driection: “S”, street_type: “BLVD”, state: “FL”, unit_type: “DWELLING”, street_name: “AVALON PARK SOUTH” }, last_name: “Smith”, first_name: “John”, phone: { phone_type: “W”, phone: “5555550123” } }