{"_id":"55cba6d437edd823001a85e5","editedParams2":true,"category":{"_id":"55cba6d337edd823001a85da","__v":1,"pages":["55cba6d437edd823001a85e0","55cba6d437edd823001a85e1","55cba6d437edd823001a85e2","55cba6d437edd823001a85e3","55cba6d437edd823001a85e4","55cba6d437edd823001a85e5"],"project":"55c80e130300460d00c91c1d","version":"55cba6d237edd823001a85d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-11T19:40:06.209Z","from_sync":false,"order":2,"slug":"lead-validation-end-api","title":"LEAD VALIDATION END API"},"parentDoc":null,"version":{"_id":"55cba6d237edd823001a85d7","project":"55c80e130300460d00c91c1d","__v":3,"createdAt":"2015-08-12T20:04:34.776Z","releaseDate":"2015-08-12T20:04:34.776Z","categories":["55cba6d337edd823001a85d8","55cba6d337edd823001a85d9","55cba6d337edd823001a85da","55cba6d337edd823001a85db","55cbd8e84cf2180d00bb1c15","561312bc41a9ec0d00a3fdfc"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":7,"editedParams":true,"project":"55c80e130300460d00c91c1d","user":"55ca76068705a70d00b8fbef","updates":["564685b9c7687d0d00739f57"],"next":{"pages":[],"description":""},"createdAt":"2015-08-12T17:41:10.094Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"<?php\n   \n$licensekey = \"\";\n\n$url =  \"https://api.accurateappend.com/Services/V2/ValidateComposite/\" . $licensekey . \"/?\";\n$querystring = \"firstname=john\" .\n               \"&lastname=smith\" .\n               \"&address=\" . urlencode(\"123 main st\") .\n               \"&city=seattle\" .\n               \"&state=wa\" .\n               \"&postalcode=98101\" .\n               \"&phone=2065551212\" .\n               \"&email=johnsmith:::at:::gmail.com\" .\n               \"&ip=50.6.78.30\" .\n               \"&verify_landline_connection_status=true\" .\n               \"&verify_deliverable=true\";\n\n$url .= $querystring;\n//echo \"request url: \" . $url . \"<br>\\n<br>\\n\";\n\nif(strtoupper(substr(PHP_OS, 0, 3)) === 'WIN')\n{\n    // windows operating system as the requesting server\n    $cacert_path_file = dirname(__FILE__) . \"\\cacert.pem\";\n}\nelse\n{\n    // other os\n    $cacert_path_file = \"cacert.pem\";\n}\n\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_HTTPGET, true);\ncurl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));\ncurl_setopt($ch, CURLOPT_SSLVERSION, 'CURL_SSLVERSION_DEFAULT');  // on a windows server the single quotes are required on 3rd parameter\ncurl_setopt($ch, CURLOPT_CAINFO, $cacert_path_file);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt($ch, CURLOPT_VERBOSE, true);\n\n$json_string = curl_exec($ch);\n$curl_err = curl_error($ch);\n\nif($curl_err)\n{\n    echo \"curl error: $curl_err\";\n}\nelse\n{\n    curl_close($ch);\n\n    // decode json\n    $parsed_json = json_decode($json_string);\n\n    // instantiate an associative array\n    $response = array();\n    // load json data into associative array\n    $response = json_to_associative($parsed_json);\n\n    // print the associative array to the screen\n    foreach ($response as $key => $value)\n    {\n        echo $key . \" = \" . $value . \"<br>\\n\";\n    }\n}\n\n\necho \"<br>\\n\";\necho \"<br>\\n\";\necho \"<br>\\n\";\necho \"<br>\\n\";\necho \"<br>\\n\";\necho \"<br>\\n\";\necho \"<br>\\n\";\n\n\n\n// --------------------------------------------------------- //\n//\n// --------------------------------------------------------- //\nfunction json_to_associative($parsed_json)\n{\n    $response = array();\n    $obj_arr = array();\n\n    // load the associative array with all response key/value pairs\n    $response['Host'] = $parsed_json->{'Criteria'}->Host;\n    $response['RequestDate'] = $parsed_json->{'Criteria'}->RequestDate;\n    $response['RequestIP'] = $parsed_json->{'Criteria'}->RequestIP;\n    $response['TransactionId'] = $parsed_json->{'Criteria'}->TransactionId;\n\n    $response['FirstName'] = $parsed_json->{'Criteria'}->FirstName;\n    $response['LastName'] = $parsed_json->{'Criteria'}->LastName;\n    $response['Email'] = $parsed_json->{'Criteria'}->Email;\n    $response['Address'] = $parsed_json->{'Criteria'}->Address;\n    $response['City'] = $parsed_json->{'Criteria'}->City;\n    $response['State'] = $parsed_json->{'Criteria'}->State;\n    $response['PostalCode'] = $parsed_json->{'Criteria'}->PostalCode;\n    $response['Telephone'] = $parsed_json->{'Criteria'}->Telephone;\n\n\n    // process \"NameResult\":\n\n    // typecast the stdClass to array\n    $obj_arr = (array)$parsed_json->{'NameResult'};\n\n    if(!empty($obj_arr))\n    {\n        $response['NameResult_FirstName1'] = $obj_arr['FirstName1'];\n\n        // a conditional added here because some people do not have a middle name and also if nobody is found\n        if(array_key_exists(\"MiddleName1\", $obj_arr))\n        {\n            $response['NameResult_MiddleName1'] = $obj_arr['MiddleName1'];\n        }\n\n        $response['NameResult_LastName1'] = $obj_arr['LastName1'];\n        $response['NameResult_Gender1'] = $obj_arr['Gender1'];\n\n\n        // because it is likely possible that only one person's name is returned add conditionals for these keys\n        if(array_key_exists(\"FirstName2\", $obj_arr))\n        {\n            $response['NameResult_FirstName2'] = $obj_arr['FirstName2'];\n        }\n        if(array_key_exists(\"MiddleName2\", $obj_arr))\n        {\n            $response['NameResult_MiddleName2'] = $obj_arr['MiddleName2'];\n        }\n        if(array_key_exists(\"LastName2\", $obj_arr))\n        {\n            $response['NameResult_LastName2'] = $obj_arr['LastName2'];\n        }\n        if(array_key_exists(\"Gender2\", $obj_arr))\n        {\n            $response['NameResult_Gender2'] = $obj_arr['Gender2'];\n        }\n\n\n        // iteration required for mulitple Phones response\n        for($i = 0; $i < count($parsed_json->{'NameResult'}->{'Codes'}); $i++)\n        {\n\n            $keynum = $i + 1;\n\n            $response['NameResult_Code' . $keynum] = $parsed_json->{'NameResult'}->{'Codes'}[$i]->Code;\n            $response['NameResult_Description' . $keynum] = $parsed_json->{'NameResult'}->{'Codes'}[$i]->Description;\n            $response['NameResult_Status' . $keynum] = $parsed_json->{'NameResult'}->{'Codes'}[$i]->Status;\n        }\n    }\n\n\n\n    // process \"EmailResult\":\n\n    $obj_arr = array();\n\n    // typecast the stdClass to array\n    $obj_arr = (array)$parsed_json->{'EmailResult'};\n\n    if(!empty($obj_arr))\n    {\n        $response['EmailResult_Domain'] = $obj_arr['Domain'];\n        $response['EmailResult_User'] = $obj_arr['User'];\n\n\n        // iteration required for mulitple Phones response\n        for($i = 0; $i < count($parsed_json->{'EmailResult'}->{'Codes'}); $i++)\n        {\n\n            $keynum = $i + 1;\n\n            $response['EmailResult_Code' . $keynum] = $parsed_json->{'EmailResult'}->{'Codes'}[$i]->Code;\n            $response['EmailResult_Description' . $keynum] = $parsed_json->{'EmailResult'}->{'Codes'}[$i]->Description;\n            $response['EmailResult_Status' . $keynum] = $parsed_json->{'EmailResult'}->{'Codes'}[$i]->Status;\n        }\n    }\n\n\n\n\n\n\n\n\n    // process \"PhoneResult\":\n\n    $obj_arr = array();\n\n\n    // typecast the stdClass to array\n    $obj_arr = (array)$parsed_json->{'PhoneResult'};\n\n    if(!empty($obj_arr))\n    {\n        if(array_key_exists(\"AreaCode\", $obj_arr))\n        {\n            $response['PhoneResult_AreaCode'] = $obj_arr['AreaCode'];\n        }\n        if(array_key_exists(\"CountryCode\", $obj_arr))\n        {\n            $response['PhoneResult_CountryCode'] = $obj_arr['CountryCode'];\n        }\n\n        if(array_key_exists(\"Prefix\", $obj_arr))\n        {\n            $response['PhoneResult_Prefix'] = $obj_arr['Prefix'];\n        }\n\n        if(array_key_exists(\"State\", $obj_arr))\n        {\n            $response['PhoneResult_State'] = $obj_arr['State'];\n        }\n\n        if(array_key_exists(\"Suffix\", $obj_arr))\n        {\n            $response['PhoneResult_Suffix'] = $obj_arr['Suffix'];\n        }\n\n        // iteration required for mulitple Phones response\n        for($i = 0; $i < count($parsed_json->{'PhoneResult'}->{'Codes'}); $i++)\n        {\n            $keynum = $i + 1;\n\n            $response['PhoneResult_Code' . $keynum] = $parsed_json->{'PhoneResult'}->{'Codes'}[$i]->Code;\n            $response['PhoneResult_Description' . $keynum] = $parsed_json->{'PhoneResult'}->{'Codes'}[$i]->Description;\n            $response['PhoneResult_Status' . $keynum] = $parsed_json->{'PhoneResult'}->{'Codes'}[$i]->Status;\n        }\n    }\n\n\n\n\n\n\n    // process \"AddressResult\":\n\n    $obj_arr = array();\n\n    $address_results_fields_array = array(\"Address\",\n                                          \"AddressRange\",\n                                          \"AddressTypeCode\",\n                                          \"CarrierRoute\",\n                                          \"City\",\n                                          \"CongressionalDistrict\",\n                                          \"CountryCode\",\n                                          \"CountyFips\",\n                                          \"CountyName\",                                         \n                                          \"State\",\n                                          \"StreetName\",\n                                          \"Suffix\",\n                                          \"TimeZone\",\n                                          \"TimeZoneCode\",\n                                          \"Zip\",\n                                          \"Zip4\");\n\n\n\n    // typecast the stdClass to array\n    $obj_arr = (array)$parsed_json->{'AddressResult'};\n\n    if(!empty($obj_arr))\n    {\n        for($j = 0; $j < count($address_results_fields_array); $j++)\n        {\n            $response[\"AddressResult_\" . $address_results_fields_array[$j]] = $obj_arr[$address_results_fields_array[$j]];\n        }\n\n\n        // iteration required for mulitple Address response\n        for($i = 0; $i < count($parsed_json->{'AddressResult'}->{'Codes'}); $i++)\n        {\n\n            $keynum = $i + 1;\n\n            $response['AddressResult_Code' . $keynum] = $parsed_json->{'AddressResult'}->{'Codes'}[$i]->Code;\n            $response['AddressResult_Description' . $keynum] = $parsed_json->{'AddressResult'}->{'Codes'}[$i]->Description;\n            $response['AddressResult_Status' . $keynum] = $parsed_json->{'AddressResult'}->{'Codes'}[$i]->Status;\n        }\n    }\n\n\n\n\n    // process \"IPAddressResult\":\n\n    $obj_arr = array();\n\n    $ip_address_results_fields_array = array(\"AccuracyRadius\",\n                                             \"AsNum\",\n                                             \"Continient\",\n                                             \"CountryCode\",\n                                             \"CountryConfidence\",\n                                             \"CountryName\",\n                                             \"ISP\",                                           \n                                             \"NetSpeed\",\n                                             \"Organization\",\n                                             \"UserType\");\n\n\n    // typecast the stdClass to array\n    $obj_arr = (array)$parsed_json->{'IPAddressResult'};\n\n    if(!empty($obj_arr))\n    {\n        for($j = 0; $j < count($ip_address_results_fields_array); $j++)\n        {\n            $response[\"IPAddressResult_\" . $ip_address_results_fields_array[$j]] = $obj_arr[$ip_address_results_fields_array[$j]];\n        }\n\n\n        for($i = 0; $i < count($parsed_json->{'IPAddressResult'}->{'Codes'}); $i++)\n        {\n            $keynum = $i + 1;\n\n            $response['IPAddressResult_Code' . $keynum] = $parsed_json->{'IPAddressResult'}->{'Codes'}[$i]->Code;\n            $response['IPAddressResult_Description' . $keynum] = $parsed_json->{'IPAddressResult'}->{'Codes'}[$i]->Description;\n            $response['IPAddressResult_Status' . $keynum] = $parsed_json->{'IPAddressResult'}->{'Codes'}[$i]->Status;\n        }\n    }\n\n\n    return $response;\n}\n\n/*\nCopyright (c) 2015, AccurateAppend Corp\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without modification, are permitted \nprovided that the following conditions are met:\n\n1. Redistributions of source code must retain the above copyright notice, this list of conditions \n   and the following disclaimer.\n\n2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions \n   and the following disclaimer in the documentation and/or other materials provided with the distribution.\n\n3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse \n   or promote products derived from this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR \nIMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND \nFITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS \nBE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, \nBUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS \nINTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR \nTORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF \nADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n*/\n\n?>","language":"php"}]},"method":"get","results":{"codes":[{"status":200,"name":"","code":"{  \n       \"Criteria\":{  \n              \"Host\":\"XXXX\",\n              \"RequestDate\":\"2015-07-14T15:31:51.3449564Z\",\n              \"RequestIP\":\"192.168.1.1\",\n              \"TransactionId\":\"e5be8f0e-a6ee-46b0-bd9b-e2450efbb70e\",\n              \"Name\":\"john a & robin d smith\",\n              \"Address\":\"123 Main St\",\n              \"City\":\"Seattle\",\n              \"PostalCode\":\"98101\",\n              \"State\":\"WA\",\n              \"Telephone\":\"2065551212\",\n              \"EmailAddress\":\"ohnsmith@gmail.com\",\n              \"IP\":\"192.168.1.1\"\n           },\n           \"NameResult\":{  \n                 \"FirstName1\":\"John\",\n                 \"MiddleName1\":\"A\",\n                 \"LastName1\":\"Smith\",\n                 \"Gender1\":\"M\",\n                 \"FirstName2\":\"Robin\",\n                 \"MiddleName2\":\"D\",\n                 \"LastName2\":\"Smith\",\n                 \"Gender2\":\"F\",\n                 \"Codes\":[\n                    {\n                        \"Status\":\"Status\",\n                        \"Code\":\"N1\",\n                        \"Description\":\"Parsing successful\"\n                    }\n                 ]\n           },\n           \"AddressResult\":{  \n                \"Address\":\"123 Main St\",\n                \"AddressRange\":\"123\",\n                \"StreetName\":\"Main\",\n                \"Suffix\":\"St\",\n                \"City\":\"Seattle\",\n                \"CountyName\":\"King\",\n                \"CountyFips\":\"53033\",\n                \"State\":\"WA\",\n                \"Zip\":\"98101\",\n                \"Zip4\":\"7418\",\n                \"CountryCode\":\"US\",\n                \"CarrierRoute\":\"C005\",\n                \"CongressionalDistrict\":\"09\",\n                \"TimeZone\":\"Pacific Time\",\n                \"TimeZoneCode\":\"08\",\n                \"AddressTypeCode\":\"S\",                \n                \"Codes\":[\n                    {\n                        \"Status\":\"Status\",\n                        \"Code\":\"A1\",\n                        \"Description\":\"Address matched to postal database\"\n                    },\n                    {\n                        \"Status\":\"DPV\",\n                        \"Code\":\"DPV3\",\n                        \"Description\":\"Address matched to DPV database\"\n                    }\n                ]\n           },\n           \"PhoneResult\":{  \n                 \"AreaCode\":\"206\",\n                 \"Prefix\":\"555\",\n                 \"Suffix\":\"1212\",\n                 \"City\":\"Seattle\",\n                 \"State\":\"WA\",\n                 \"CountryCode\":\"1\",\n                 \"CountyFips\":\"1234\",\n                 \"CountyName\":\"King\",\n                 \"Distance\":\"6\",                 \n                 \"Msa\":\"7602\",\n                 \"Pmsa\":\"7600\",\n                 \"TimeZone\":\"Pacific Time\",\n                 \"TimeZoneCode\":\"08\",\n                 \"LineType\":\"S\",\n                 \"Codes\":[\n                    {\n                        \"Status\":\"Status\",\n                        \"Code\":\"P2\",\n                        \"Description\":\"Area code, exchange and the first digit of the suffix verified.\"\n                    },\n                    {\n                        \"Status\":\"Status\",\n                        \"Code\":\"P22\",\n                        \"Description\":\"Phone number connection status has been verified.\"\n                    }\n                 ]\n           },\n           \"EmailResult\":{  \n                 \"User\":\"johnsmith\",\n                 \"Domain\":\"gmail.com\",\n                 \"Codes\":[\n                    {\n                        \"Status\":\"Status\",\n                        \"Code\":\"E11\",\n                        \"Description\":\"Syntax OK\"\n                    },\n                    {\n                        \"Status\":\"Status\",\n                        \"Code\":\"E10\",\n                        \"Description\":\"Email address verified with ISP as deliverable\"\n                    }\n                 ]\n           },\n           \"CompositeResult\":{  \n                 \"Codes\":[\n                    {\n                        \"Status\":\"Confirmation\",\n                        \"Code\":\"C11\",\n                        \"Description\":\"First name, last name, postal address and phone number match in Source 2.\"\n                    }\n                 ]\n           }\n    }","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"55cbe22b9d3dc20d009494de","ref":"","in":"path","required":true,"desc":"License key issued by customer support.","default":"","type":"string","name":"licensekey"},{"_id":"55cbe22b9d3dc20d009494dd","ref":"","in":"query","required":true,"desc":"First name of search subject.","default":"","type":"string","name":"firstname"},{"_id":"55cbe22b9d3dc20d009494dc","ref":"","in":"query","required":true,"desc":"Last name or full name. System automatically combines firstname and lastname fields and then parses the resulting value.","default":"","type":"string","name":"lastname"},{"_id":"55cbe2599d3dc20d009494e2","ref":"","in":"query","required":true,"desc":"Full street address including house number and street name.","default":"","type":"string","name":"address"},{"_id":"55cbe2599d3dc20d009494e1","ref":"","in":"query","required":false,"desc":"City of input address. Optional, if postalcode is used.","default":"","type":"string","name":"city"},{"_id":"55cbe2714cf2180d00bb1c26","ref":"","in":"query","required":false,"desc":"State of input address. Optional, if postalcode is used.","default":"","type":"string","name":"state"},{"_id":"55cbe29b2767710d00bc9c2b","ref":"","in":"query","required":false,"desc":"5- or 9-digit postal code of input address. Optional, if city and state are used.","default":"","type":"string","name":"postalcode"},{"_id":"55cbe2ea4cf2180d00bb1c28","ref":"","in":"query","required":false,"desc":"7- or 10 digit phone number","default":"","type":"string","name":"phone"},{"_id":"55cbe2ea4cf2180d00bb1c27","ref":"","in":"query","required":true,"desc":"Indicates whether the telephone number should be matched against the daily updated directory assistance database, which is a strong indication of connectivity.","default":"","type":"boolean","name":"verifyconnectionstatus"},{"_id":"55cbe34f2767710d00bc9c2d","ref":"","in":"query","required":false,"desc":"Email address of prospect","default":"","type":"string","name":"email"},{"_id":"55cbe34f2767710d00bc9c2c","ref":"","in":"query","required":true,"desc":"Verifies current email address delivery status by contacting the ISP’s email server and checking for existence of the mailbox.","default":"","type":"boolean","name":"verifydeliverable"}],"url":"/ValidateComposite/:licensekey/?"},"isReference":false,"order":5,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"HTTP Headers\",\n  \"body\": \"When making a call to this API, the HTTP header \\\"content-type\\\" MUST be supplied with a value of \\\"application/json\\\". Failure to include this header will result in an HTTP 400 Bad Request response. Your choice of client library may automatically include this header. Please consult your documentation.\"\n}\n[/block]\n## NameResult\nIf request contains two names then two separate sets of names and gender are returned.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"FirstName1\",\n    \"0-2\": \"Parsed first name\",\n    \"0-1\": \"string\",\n    \"1-0\": \"MiddleName1\",\n    \"1-2\": \"Parsed middle name\",\n    \"2-0\": \"LastName1\",\n    \"2-2\": \"Parsed last name\",\n    \"3-0\": \"FirstName2\",\n    \"3-2\": \"Parsed first name\",\n    \"4-0\": \"MiddleName2\",\n    \"4-2\": \"Parsed middle name\",\n    \"5-0\": \"LastName2\",\n    \"5-2\": \"Parsed last name\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string\",\n    \"5-1\": \"string\",\n    \"6-0\": \"Codes\",\n    \"6-2\": \"Parsing and validation results. See Status codes\",\n    \"6-1\": \"array\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\n## AddressResult\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"Address\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Formatted full street address\",\n    \"1-0\": \"AddressRange\",\n    \"1-2\": \"Parsed address range\",\n    \"1-1\": \"string\",\n    \"2-0\": \"StreetName\",\n    \"2-2\": \"Parsed street name\",\n    \"3-0\": \"Suffix\",\n    \"3-2\": \"Parsed street suffix. i.e. St, Ave, Rd\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string\",\n    \"4-0\": \"PostDirection\",\n    \"4-2\": \"Parsed street post direction\",\n    \"5-0\": \"City\",\n    \"5-2\": \"Parsed and corrected city\",\n    \"6-0\": \"CountyName\",\n    \"6-2\": \"County name\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"7-1\": \"string\",\n    \"7-0\": \"CountyFips\",\n    \"7-2\": \"County FIP code\",\n    \"8-0\": \"State\",\n    \"8-2\": \"2 digit state abbreviation\",\n    \"9-0\": \"Zip\",\n    \"9-2\": \"5 digit postal code\",\n    \"10-0\": \"Zip4\",\n    \"10-2\": \"4 digit Zip extension\",\n    \"11-0\": \"CountryCode\",\n    \"11-1\": \"string\",\n    \"10-1\": \"string\",\n    \"9-1\": \"string\",\n    \"8-1\": \"string\",\n    \"12-1\": \"string\",\n    \"11-2\": \"Country code\",\n    \"12-0\": \"CarrierRoute\",\n    \"12-2\": \"Carrier route number\",\n    \"13-0\": \"CongressionalDistrict\",\n    \"13-2\": \"Congressional district number\",\n    \"13-1\": \"string\",\n    \"14-1\": \"string\",\n    \"14-0\": \"TimeZone\",\n    \"14-2\": \"Time zone description\",\n    \"15-0\": \"TimeZoneCode\",\n    \"15-1\": \"string\",\n    \"15-2\": \"Time zone code\",\n    \"16-0\": \"AddressTypeCode\",\n    \"16-1\": \"string\",\n    \"16-2\": \"Address type code\",\n    \"17-1\": \"array\",\n    \"17-0\": \"Codes\",\n    \"17-2\": \"Result\"\n  },\n  \"cols\": 3,\n  \"rows\": 18\n}\n[/block]\n## PhoneResult\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"AreaCode\",\n    \"0-2\": \"Area code\",\n    \"1-0\": \"Prefix\",\n    \"1-2\": \"3 digit prefix\",\n    \"2-0\": \"Suffix\",\n    \"2-2\": \"4 digit suffix\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-0\": \"City\",\n    \"3-2\": \"City\",\n    \"4-0\": \"State\",\n    \"4-2\": \"State\",\n    \"5-0\": \"CountryCode\",\n    \"5-2\": \"Country code\",\n    \"6-0\": \"CountyFips\",\n    \"6-2\": \"County Fips code\",\n    \"4-1\": \"string\",\n    \"3-1\": \"string\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"7-0\": \"CountyName\",\n    \"7-1\": \"string\",\n    \"8-1\": \"string\",\n    \"7-2\": \"County name\",\n    \"8-0\": \"Distance\",\n    \"8-2\": \"Distance from input postal code\",\n    \"9-0\": \"Msa\",\n    \"9-2\": \"Metropolitan Statistical Area\",\n    \"10-0\": \"Pmsa\",\n    \"10-2\": \"Primary Metropolitan Statistical Area\",\n    \"11-0\": \"TimeZone\",\n    \"11-2\": \"Time zone\",\n    \"9-1\": \"string\",\n    \"10-1\": \"string\",\n    \"11-1\": \"string\",\n    \"12-0\": \"TimeZoneCode\",\n    \"12-1\": \"string\",\n    \"13-1\": \"string\",\n    \"14-1\": \"array\",\n    \"12-2\": \"Time zone code\",\n    \"13-0\": \"LineType\",\n    \"13-2\": \"See Line Type.\",\n    \"14-0\": \"Codes\",\n    \"14-2\": \"Parsing and validation results. See Status codes.\"\n  },\n  \"cols\": 3,\n  \"rows\": 15\n}\n[/block]\n## IPAddressResultResult\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"CountryCode\",\n    \"0-2\": \"Country code\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"2-1\": \"string\",\n    \"3-1\": \"string\",\n    \"4-1\": \"string\",\n    \"1-0\": \"CountryName\",\n    \"1-2\": \"Country name\",\n    \"2-0\": \"RegionCode\",\n    \"2-2\": \"Region code\",\n    \"3-0\": \"RegionName\",\n    \"3-2\": \"Region name\",\n    \"4-0\": \"City\",\n    \"4-2\": \"Location city\",\n    \"5-0\": \"MetroCode\",\n    \"5-2\": \"Metropolitan Statistical Area\",\n    \"5-1\": \"string\",\n    \"6-1\": \"string\",\n    \"6-0\": \"AreaCode\",\n    \"6-2\": \"Location area code\",\n    \"7-0\": \"Continient\",\n    \"7-2\": \"Continient\",\n    \"8-0\": \"PostalCode\",\n    \"8-2\": \"Location postal code\",\n    \"7-1\": \"string\",\n    \"8-1\": \"string\",\n    \"9-1\": \"string\",\n    \"9-0\": \"ISP\",\n    \"9-2\": \"The name of the ISP associated with the IP address\",\n    \"10-0\": \"Organization\",\n    \"10-2\": \"The name of the organization associated with the IP address\",\n    \"11-0\": \"Domain\",\n    \"11-2\": \"Domain\",\n    \"10-1\": \"string\",\n    \"11-1\": \"string\",\n    \"12-0\": \"AsNum\",\n    \"12-2\": \"Autonomous system number\",\n    \"12-1\": \"string\",\n    \"13-1\": \"string\",\n    \"13-0\": \"NetSpeed\",\n    \"13-2\": \"Estimated line type\",\n    \"14-0\": \"UserType\",\n    \"14-2\": \"User type\",\n    \"15-0\": \"AccuracyRadius\",\n    \"15-2\": \"The radius in kilometers around the specified location where the IP address is likely to be\",\n    \"16-0\": \"CountryConfidence\",\n    \"16-2\": \"Numeric score between 1 and 100 indicating confidence\",\n    \"15-1\": \"string\",\n    \"16-1\": \"string\",\n    \"17-0\": \"CityConfidence\",\n    \"17-2\": \"Numeric score between 1 and 100 indicating confidence\",\n    \"18-0\": \"RegionConfidence\",\n    \"17-1\": \"string\",\n    \"18-1\": \"string\",\n    \"19-1\": \"string\",\n    \"18-2\": \"Numeric score between 1 and 100 indicating confidence\",\n    \"19-0\": \"PostalCodeConfidence\",\n    \"19-2\": \"Numeric score between 1 and 100 indicating confidence\",\n    \"20-0\": \"Codes\",\n    \"20-1\": \"array\",\n    \"20-2\": \"Parsing and validation results. See Status codes.\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]\n## EmailResult\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field name\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"User\",\n    \"0-2\": \"Parsed username\",\n    \"0-1\": \"string\",\n    \"1-1\": \"string\",\n    \"1-0\": \"Domain\",\n    \"1-2\": \"Parsed domain name\",\n    \"2-0\": \"Codes\",\n    \"2-1\": \"array\",\n    \"2-2\": \"Parsing and validation results. See Status codes.\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## ValidateComposite Status Codes\nThis section lists the following types of status codes for the ValidateComposite method.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Code\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"C1\",\n    \"0-1\": \"First name, last name, postal address and phone number match in Source 1\",\n    \"1-0\": \"C2\",\n    \"1-1\": \"Last name, postal address and phone number match in Source 1\",\n    \"2-0\": \"C3\",\n    \"2-1\": \"Last name and phone number match in Source 1\",\n    \"3-0\": \"C5\",\n    \"3-1\": \"Postal address and phone number match in Source 1\",\n    \"4-0\": \"C11\",\n    \"4-1\": \"First name, last name, postal address and phone number match in Source 2\",\n    \"5-0\": \"C12\",\n    \"5-1\": \"Last name, postal address and phone number match in Source 2\",\n    \"6-0\": \"C13\",\n    \"6-1\": \"Last name and phone number match in Source 2\",\n    \"7-0\": \"C15\",\n    \"7-1\": \"Postal address and phone number match in Source 2\",\n    \"8-0\": \"C16\",\n    \"8-1\": \"First name, last name, postal address and phone number match in Source 3\",\n    \"9-0\": \"C17\",\n    \"9-1\": \"Last name, postal address and phone number match in Source 3\",\n    \"10-0\": \"C18\",\n    \"10-1\": \"Last name and phone number match in Source 3\",\n    \"11-0\": \"C19\",\n    \"11-1\": \"Postal address and phone number match in Source 3\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\n## Error Messages\nFor a list of codes and descriptions click [here](http://docs.accurateappend.com/docs/error-messages).","excerpt":"This section describes request parameters, responses and potential error messages for the ValidateComposite method.\n\n- Combination of the separate validation methods: Name, address, phone, email, and IP address.\n- Validate all components of a lead with a single call.\n- Validates the relationship between all components of a lead to verify the identity of the underlying individual.","slug":"validatelead","type":"endpoint","title":"Validate Lead"}

getValidate Lead

This section describes request parameters, responses and potential error messages for the ValidateComposite method. - Combination of the separate validation methods: Name, address, phone, email, and IP address. - Validate all components of a lead with a single call. - Validates the relationship between all components of a lead to verify the identity of the underlying individual.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

licensekey:
required
string
License key issued by customer support.

Query Params

firstname:
required
string
First name of search subject.
lastname:
required
string
Last name or full name. System automatically combines firstname and lastname fields and then parses the resulting value.
address:
required
string
Full street address including house number and street name.
city:
string
City of input address. Optional, if postalcode is used.
state:
string
State of input address. Optional, if postalcode is used.
postalcode:
string
5- or 9-digit postal code of input address. Optional, if city and state are used.
phone:
string
7- or 10 digit phone number
verifyconnectionstatus:
required
boolean
Indicates whether the telephone number should be matched against the daily updated directory assistance database, which is a strong indication of connectivity.
email:
string
Email address of prospect
verifydeliverable:
required
boolean
Verifies current email address delivery status by contacting the ISP’s email server and checking for existence of the mailbox.

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "HTTP Headers", "body": "When making a call to this API, the HTTP header \"content-type\" MUST be supplied with a value of \"application/json\". Failure to include this header will result in an HTTP 400 Bad Request response. Your choice of client library may automatically include this header. Please consult your documentation." } [/block] ## NameResult If request contains two names then two separate sets of names and gender are returned. [block:parameters] { "data": { "h-0": "Field name", "h-1": "Type", "h-2": "Description", "0-0": "FirstName1", "0-2": "Parsed first name", "0-1": "string", "1-0": "MiddleName1", "1-2": "Parsed middle name", "2-0": "LastName1", "2-2": "Parsed last name", "3-0": "FirstName2", "3-2": "Parsed first name", "4-0": "MiddleName2", "4-2": "Parsed middle name", "5-0": "LastName2", "5-2": "Parsed last name", "1-1": "string", "2-1": "string", "3-1": "string", "4-1": "string", "5-1": "string", "6-0": "Codes", "6-2": "Parsing and validation results. See Status codes", "6-1": "array" }, "cols": 3, "rows": 7 } [/block] ## AddressResult [block:parameters] { "data": { "h-0": "Field name", "h-1": "Type", "h-2": "Description", "0-0": "Address", "0-1": "string", "0-2": "Formatted full street address", "1-0": "AddressRange", "1-2": "Parsed address range", "1-1": "string", "2-0": "StreetName", "2-2": "Parsed street name", "3-0": "Suffix", "3-2": "Parsed street suffix. i.e. St, Ave, Rd", "2-1": "string", "3-1": "string", "4-1": "string", "4-0": "PostDirection", "4-2": "Parsed street post direction", "5-0": "City", "5-2": "Parsed and corrected city", "6-0": "CountyName", "6-2": "County name", "5-1": "string", "6-1": "string", "7-1": "string", "7-0": "CountyFips", "7-2": "County FIP code", "8-0": "State", "8-2": "2 digit state abbreviation", "9-0": "Zip", "9-2": "5 digit postal code", "10-0": "Zip4", "10-2": "4 digit Zip extension", "11-0": "CountryCode", "11-1": "string", "10-1": "string", "9-1": "string", "8-1": "string", "12-1": "string", "11-2": "Country code", "12-0": "CarrierRoute", "12-2": "Carrier route number", "13-0": "CongressionalDistrict", "13-2": "Congressional district number", "13-1": "string", "14-1": "string", "14-0": "TimeZone", "14-2": "Time zone description", "15-0": "TimeZoneCode", "15-1": "string", "15-2": "Time zone code", "16-0": "AddressTypeCode", "16-1": "string", "16-2": "Address type code", "17-1": "array", "17-0": "Codes", "17-2": "Result" }, "cols": 3, "rows": 18 } [/block] ## PhoneResult [block:parameters] { "data": { "h-0": "Field name", "h-1": "Type", "h-2": "Description", "0-0": "AreaCode", "0-2": "Area code", "1-0": "Prefix", "1-2": "3 digit prefix", "2-0": "Suffix", "2-2": "4 digit suffix", "0-1": "string", "1-1": "string", "2-1": "string", "3-0": "City", "3-2": "City", "4-0": "State", "4-2": "State", "5-0": "CountryCode", "5-2": "Country code", "6-0": "CountyFips", "6-2": "County Fips code", "4-1": "string", "3-1": "string", "5-1": "string", "6-1": "string", "7-0": "CountyName", "7-1": "string", "8-1": "string", "7-2": "County name", "8-0": "Distance", "8-2": "Distance from input postal code", "9-0": "Msa", "9-2": "Metropolitan Statistical Area", "10-0": "Pmsa", "10-2": "Primary Metropolitan Statistical Area", "11-0": "TimeZone", "11-2": "Time zone", "9-1": "string", "10-1": "string", "11-1": "string", "12-0": "TimeZoneCode", "12-1": "string", "13-1": "string", "14-1": "array", "12-2": "Time zone code", "13-0": "LineType", "13-2": "See Line Type.", "14-0": "Codes", "14-2": "Parsing and validation results. See Status codes." }, "cols": 3, "rows": 15 } [/block] ## IPAddressResultResult [block:parameters] { "data": { "h-0": "Field name", "h-1": "Type", "h-2": "Description", "0-0": "CountryCode", "0-2": "Country code", "0-1": "string", "1-1": "string", "2-1": "string", "3-1": "string", "4-1": "string", "1-0": "CountryName", "1-2": "Country name", "2-0": "RegionCode", "2-2": "Region code", "3-0": "RegionName", "3-2": "Region name", "4-0": "City", "4-2": "Location city", "5-0": "MetroCode", "5-2": "Metropolitan Statistical Area", "5-1": "string", "6-1": "string", "6-0": "AreaCode", "6-2": "Location area code", "7-0": "Continient", "7-2": "Continient", "8-0": "PostalCode", "8-2": "Location postal code", "7-1": "string", "8-1": "string", "9-1": "string", "9-0": "ISP", "9-2": "The name of the ISP associated with the IP address", "10-0": "Organization", "10-2": "The name of the organization associated with the IP address", "11-0": "Domain", "11-2": "Domain", "10-1": "string", "11-1": "string", "12-0": "AsNum", "12-2": "Autonomous system number", "12-1": "string", "13-1": "string", "13-0": "NetSpeed", "13-2": "Estimated line type", "14-0": "UserType", "14-2": "User type", "15-0": "AccuracyRadius", "15-2": "The radius in kilometers around the specified location where the IP address is likely to be", "16-0": "CountryConfidence", "16-2": "Numeric score between 1 and 100 indicating confidence", "15-1": "string", "16-1": "string", "17-0": "CityConfidence", "17-2": "Numeric score between 1 and 100 indicating confidence", "18-0": "RegionConfidence", "17-1": "string", "18-1": "string", "19-1": "string", "18-2": "Numeric score between 1 and 100 indicating confidence", "19-0": "PostalCodeConfidence", "19-2": "Numeric score between 1 and 100 indicating confidence", "20-0": "Codes", "20-1": "array", "20-2": "Parsing and validation results. See Status codes." }, "cols": 3, "rows": 21 } [/block] ## EmailResult [block:parameters] { "data": { "h-0": "Field name", "h-1": "Type", "h-2": "Description", "0-0": "User", "0-2": "Parsed username", "0-1": "string", "1-1": "string", "1-0": "Domain", "1-2": "Parsed domain name", "2-0": "Codes", "2-1": "array", "2-2": "Parsing and validation results. See Status codes." }, "cols": 3, "rows": 3 } [/block] ## ValidateComposite Status Codes This section lists the following types of status codes for the ValidateComposite method. [block:parameters] { "data": { "h-0": "Code", "h-1": "Description", "0-0": "C1", "0-1": "First name, last name, postal address and phone number match in Source 1", "1-0": "C2", "1-1": "Last name, postal address and phone number match in Source 1", "2-0": "C3", "2-1": "Last name and phone number match in Source 1", "3-0": "C5", "3-1": "Postal address and phone number match in Source 1", "4-0": "C11", "4-1": "First name, last name, postal address and phone number match in Source 2", "5-0": "C12", "5-1": "Last name, postal address and phone number match in Source 2", "6-0": "C13", "6-1": "Last name and phone number match in Source 2", "7-0": "C15", "7-1": "Postal address and phone number match in Source 2", "8-0": "C16", "8-1": "First name, last name, postal address and phone number match in Source 3", "9-0": "C17", "9-1": "Last name, postal address and phone number match in Source 3", "10-0": "C18", "10-1": "Last name and phone number match in Source 3", "11-0": "C19", "11-1": "Postal address and phone number match in Source 3" }, "cols": 2, "rows": 12 } [/block] ## Error Messages For a list of codes and descriptions click [here](http://docs.accurateappend.com/docs/error-messages).

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}