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 request basic contact information (First and Last name, Postal Address, and Phone) for decrypted emails.

Request URL


Decrypt Email

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

Decrypt and Append

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

Parameters


Config Parameters

Use the config parameters to provide your API key and adjust options like the output language.

Name Description Required?
k2 Your API key Yes
service Which API service to use. Use "decrypt" for a decrypted email, or "decryptappend" for decrypted email plus full name, postal address, and phone number. 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 use search parameters to try to match an encrypted email.

Name Description
d_email Encrypted email address
Example: d_email=b3adf70d5e761b380cf87e4dbdec9be1

Output Fields


API results include:

  • Version - API version
  • Query-id - An ID unique to each query
  • Results - API results
  • Input-query - List of the input search parameters you provided and their values
  • Num-results - The number of matched records for the given search parameters
  • Query-time - How long the processing took
  • Page-time - How long the lookup took

Results section:

The results section contains the following fields. See the sample below for the format in JSON.

Result Key Description Service
EmailAddr Decrypted email address decrypt
FirstName First name decryptappend
LastName Last name decryptappend
Address Street adress decryptappend
City City decryptappend
State State decryptappend
Zip Zip decryptappend
Zip4 Zip + 4 decryptappend
Country Country Code decryptappend
Phone 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 record, then no results are returned. The result for no search results appears 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 Responses


Decrypt an email address and append basic contact data:

https://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"
  }
}