Consumer Phone Append

get

https://api.accurateappend.com/Services/V2/AppendPhone/Residential/{licensekey}/

Add mobile and landline phone numbers to your contact records by searching our database using existing contact fields such as first name, last name, city, state, and postal address.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

🚧
HTTP Header
The "content-type" in the HTTP header must be set to "application/json", otherwise an HTTP 400 Bad Request response will be returned.

Response

A single response may include one and only one Phone element for each Source requested.

Field name	Type	Description
Areacode	string	3 digit US area code
PhoneNumber	string	7 digit US phone number
LineType	enum	Indicates the LineType
MatchLevel	enum	Indicates the MatchLevel under which the match was found.
MaxValidationLevel	enum	Indicates the maximum validation level achieved by the input criteria. Measured as MatchLevel.
Source	enum	Indicates in which Source the match was found. (Source A is not supported - use ADS Consumer Phone Appendinstead)

LineType codes

[Click for a list of LineType codes and descriptions] (https://docs.accurateappend.com/reference/linetype).

HTTP Error Messages

Click to see a complete listing of error messages and codes.

Path Params

licensekey

string

required

License key issued by customer support. Click here for a trial key

Query Params

firstname

string

Search subject's first name. Optional.

lastname

string

Search subject's last name. Full name can be passed into the lastname field. Our system will parse the contents of the field into first and last name for the purposes of the append.

address

string

Search subject's address. Currently only US postal addresses are accepted. Addresses are parsed and corrected by our system using CASS software prior to matching.

city

string

City associated with search subject's address. Optional, if postal code is passed in the request.

state

string

State associated with search subject's address. Optional, if postal code is passed in the request.

postalcode

string

Postal code associated with search subject's address. Optional, if city and state are passed in the request.

source

string

Semi-colon delimited list of target Sources to search. If omitted, source D;P;M will be selected. Sources are searched in the order they are entered. Click here for for a list of Source codes and descriptions.

matchlevel

string

Semi-colon delimited list of MatchLevels used to filter response. If omitted, the match levels E1;E2;N1;N2;B1;B2 will be used. [Click for a list of MatchLevel codes and descriptions] ((https://docs.accurateappend.com/reference/matchlevel-consumer-1))).

singleBestMatch

boolean

Limits the service response to return the first match found and based on source preference. Example: If sources D;P;M are input and a match is found in D, the service would return the first match and nothing else.

suppression

string

Semi-colon delimited list containing up to 10 ten digit, numeric phone numbers to be suppressed from query and results.

Responses

HTTP Header

Response

LineType codes

HTTP Error Messages

200200

400400