TCPA Verify Tutorial
Overview
TCPA Verify is a real-time solution for validating the status of a phone number.
TCPA Verify URI
The TCPA Verify URI accepts a person’s name, address, and phone number and returns the phone type and phone’s verification code.
Required Information
The TCPA 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 TCPA 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 TCPA Verify URI must be used with a POST request, where the request payload contains the name of the person who owns the phone, their address, and the phone number to verify.
Example
Request URL
The URL for the TCPA Verify URI is: https://api.thedatagroup.com/{version}/sync/verify/tcpa, 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 TCPA Verify URI must contain the first_name, last_name, phone, and address_1 attributes. It must also contain either the zipcode attribute or both the city and state attributes.
{ "first_name": "Richard", "last_name": "Young", "address_1": "4689 Lakewood Drive", "zipcode": "32003", "phone": "4765559876" }
cURL Example
To query the TCPA 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 "Content-Type: application/json" -H "AuthorizationToken: {your_token}" -H "x-api-key: {your_key}" -H "Cache-Control: no-cache" -d '{ "first_name": "Richard", "last_name": "Young", "address_1": "4689 Lakewood Drive", "zipcode": "32003", "phone": "4765559876" }' "https://api.thedatagroup.com/v3/sync/verify/phone"
Response Payload
The response payload for the TCPA Verify URI will contain the phone type and the phone’s verification code.
{ "phone_type": "W",