Datafinder.com - Predictive Scores, Data Hygiene, Contact Data Append

Email Decryption API Documentation

Email Decryption API Overview

Use the Datafinder API to programmatically decrypt encrypted email addresses in your customer or prospect list. Optionally, you can also return a First and Last name and Postal Address for decrypted emails.

Inputs and outputs:

For a complete list of inputs please see the "Parameters" section. For a complete list of outputs, please see the "Output Fields" section.

Request URL


Decrypt Email

http://api.datafinder.com/qdf.php?k2={your-key}&service=decrpyt&d_email={encrypted-email-or-address}

Decrypt and Append

http://api.datafinder.com/qdf.php?k2={your-key}&service=decryptappend&d_email={encrypted-email-or-address}

Parameters


Config Parameters

Use the config parameters to adjust elements like the output language.

Name Description Required?
k2 Your api key Yes
service Which API service to use. Use "email" or "phone" in this case. Yes
output Specify json or xml output responses. Default is JSON.
Example: output=json

Search Parameters

Any parameter that begins with a "d_" is a search parameter. We will use these parameters to try and match an individual or household. Some search parameters will not return results if used by themselves, such as d_last or d_first. If a search parameter requires another, it will be noted in the table below.

Name Description
d_email Encrypted email address
Example: d_email=b3adf70d5e761b380cf87e4dbdec9be1

Output Fields


Api results will follow the schema shown below and will include:

  • version - api version
  • query-id - id unique to each query
  • results - list of append results
  • input-query - list of input search parameters and their values
  • num-results - number of match records for the given search parameters
  • query-time - how long the processing took
  • page-time - how long the lookup took

Fields returned for each records in the "results":

Name Description Service
EmailAddr An email address decrypt
FirstName A first name decryptappend
LastName A last name decryptappend
Address A street adress decryptappend
City A city decryptappend
State A state decryptappend
Zip A zip decryptappend
Zip4 Zip4 decryptappend
Country Country Code decryptappend
Phone A phone number decryptappend

Output schema in JSON:

{
  "datafinder": {
    "version": "2.0",
    "query-id": "xxxxxx",
    "results": [
      {
        "key": "value"
      }
    ],
    "input-query": {
      "key": "value"
    },
    "num-results": 1,
    "query-time": "0.000",
    "page-time": "0.000"
  }
}
       

If we cannot match the input search parameters to a recod then no results will be returned. The result would appear as follows:

{
  "datafinder": {
    "version": "2.0",
    "query-id": "xxx",
    "input-query": {
      "EmailAddr": "b3adf70d5e761b380cf87e4dbdec9be1"
    },
    "num-results": 0,
    "query-time": "0.138",
    "page-time": "0.193"
  }
}
           

Example Queries and Response


Decrypt an email address and append basic contact data:

http://api.datafinder.com/qdf.php?k2=key&service=decryptappend&d_email=fb2aec358d09dc8774526f63b26325cf

{
  "datafinder": {
    "version": "2.0",
    "query-id": "510c7f5fa724fd3f86aadaa5e302bce2",
    "results": [
      {
        "FirstName":"Veronica",
        "LastName":"Quek",
        "Address":"1 Contoso Way",
        "City":"Columbus",
        "State":"OH",
        "Zip":"47736",
        "Zip4":"2018",
        "Country":"US",
        "Phone":"'8183337890",
        "EmailAddr":"VQUEK@CONTOSO.COM"
      }
    ],
    "input-query": {
      "EmailAddr":"fb2aec358d09dc8774526f63b26325cf"
    },
    "num-results": 1,
    "query-time": "0.453",
    "page-time": "2.364"
  }
}