Developer

Build, integrate, extend.

Overview

iProfile provides REST API which can return XML or JSON output. This document explains how to access the iProfile API

Authentication

iProfile will assign every LeadIQ account with a pair of keys. These keys are used for authentication and signing of API requests.


Batch Contact Query POST

This request schedules a search for the given batch of contacts. The reply contains a batch request id which can be used to get the results of the batch request in the future.

Resource URL

http:/api.iprofile.net/contacts.format Where format can be json OR xml

Input Schema

Name Type ..
api_key string required - E.g: XA323643Xaaa199329393
api_secret string required - E.g: shdjhfdhkfdhhf298749
contacts array Array of hashes containing criteria for querying a contact
        company_name string Bar Corporation
        first_name string John
        last_name string Smith
        job_title string Sr. Architect
        email string john.smith@barcorp.com
        phone string (650) xxx-4527
        address1 string 223 Dome Ave
        address2 string
        city string Florence
        state string TX
        zip string 46469
        country string US
        customer_contact_id string c1002833. Same id is returned in the reply. Can be used to map the iProfile contact to customer contact.
        ip_address string 101.xx.56.37

Reply Schema

Name Type ..
id string batch id. Can be used to query the status of the batch request.
status string pending: The search is pending.
in_progress: The search is in progress.
completed: The search is complete.

HTTP Reply codes

Code Description
HTTP 200 OK Success
HTTP 401 Unauthorized Authentication failure.
HTTP 422 Unprocessable Entity Invalid or missing API input parameter(s).
HTTP 500 Internal Server Server error.

Sample Input/Reply


{
  api_key:    “XA323643Xaaa199329393”,
  api_secret:  “shdjhfdhkfdhhf29”,
  contacts: [
    {
      first_name: “John”,
      last_name:  “Smith”,
      email:      “john.smith@barcorp.com”
    },
    {
      first_name: “Maggie,
      last_name:  “Trekker”,
      email:      “maggie.trekker@foo.com”
    }
  ]
}
{
  id: 1
  user_id: 2
  status: “pending”
  created_at:  “Mon Jun 27 01:21:23 +0000 2011”
}
{
  error: "Invalid or missing API authentication parameter(s)(API key/signature/epoch)"
}

Query Contacts GET

This request can be used to

  • Get the results of a prior batch search request. The input parameters should contain the search_batch_id parameter.
  • Perform a shallow single contact search. The input parameters should contain the contact search parameters as listed in the POST contacts API documentation.

A shallow search returns immediately and the search returns failure upon not finding the contact in the IProfile database.

Resource URL

http:/api.iprofile.net/contacts.format Where format can be json OR xml

Input Schema

Name Type ..
api_key string required - E.g: XA323643Xaaa199329393
api_secret string required - E.g: shdjhfdhkfdhhf298749
batch_id string Batch id returned in the POST request. When present the contact search parameters are ignored.
include_contacts boolean true/false, defaults to true. The contacts list is returned only when the “include_contacts” parameter is set to true.
company_name
first_name
last_name
email
phone
address1
address2
city
state
zip
country
customer_contact_id
ip_address
string Refer to the input section of Batch Contact Query API for more details. Search parameters are ignored when batch_id is present.

Reply Schema

Name Type ..
status string Refer to the reply status section for more details
contacts array Array hashes representing contact.
contacts/[n]/status string Refer to the reply status section for more details
contacts/[n]/customer_contact_id string Client specific id provided in the request
contacts/[n]/(contact_fields)+ Refer to the Contact schema section for details

HTTP Reply codes

Code Description
HTTP 200 OK Success
HTTP 401 Unauthorized Authentication failure.
HTTP 422 Unprocessable Entity Invalid or missing API input parameter(s).
HTTP 500 Internal Server Server error.

Reply Status codes

Status field Description
status pending: The search is pending.
in_progress: The search is in progress.
completed: The search is complete.
contacts/[n]/status pending: The search is pending.
found: The contact is found.
not_found: The contact is not found.
insufficient_input: The contact search failed due to insufficient/invalid search parameters. Same code is set when the input resembles junk or spam.

Sample Reply

{
  status: “completed”,
  contacts: [
    {
      status: “found”,
      customer_contact_id: "c444",
      first_name: “John”,
      last_name: “Smith”,
      email: “john.smith@barcorp.com”,
      title: "Sr. Architect"
      .. See contact schema section for more details.
    },
    {
      status: “not_found”,
      customer_contact_id: "c445",
      first_name: “Maggie”,
      last_name: “Trekker”
    }
  ]
}
{
  error: "Invalid or missing API authentication parameter(s)(API key/signature/epoch)"
}

Query Company GET

This request is used to query a company.

Resource URL

http:/api.iprofile.net/companies.format Where format can be json OR xml

Input Schema

Name Type ..
api_key string required - E.g: XA323643Xaaa199329393
api_secret string required - E.g: shdjhfdhkfdhhf298749
customer_company_id string Client specific company_id. Returned in reply
company_url string http:/www.barcorp.com
company_name string Bar Corporation
first_name string John
last_name string Smith
job_title string Sr. Architect
email string john.smith@barcorp.com
phone string (650) xxx-4527
address1 string 223 Dome Ave
address2 string
city string Florence
state string TX
zip string 46469
country string US
customer_contact_id string c1002833.
ip_address string 101.xx.56.37

Reply Schema

Name Type ..
status string Refer to the reply status section for more details
companies array Array hashes representing company.
companies/[n]/status string Refer to the reply status section for more details
companies/[n]/customer_company_id string Client specific id provided in the request
companies/[n]/(company fields)+ Refer to the Company schema section for details

HTTP Reply codes

Code Description
HTTP 200 OK Success
HTTP 401 Unauthorized Authentication failure.
HTTP 422 Unprocessable Entity Invalid or missing API input parameter(s).
HTTP 500 Internal Server Server error.

Reply Status codes

Status field Description
status pending: The search is pending.
in_progress: The search is in progress.
completed: The search is complete.
companies/[n]/status pending: The search is pending.
found: The company is found.
not_found: The company is not found.
insufficient_input: The company search failed due to insufficient/invalid search parameters. Same code is set when the input resembles junk or spam.

Sample Reply

{  
  status: “completed”,
  companies: [
    {
      status: “found”,
      customer_company_id: “c384309”,
      name: “Bar Corporation”,
      url: “www.barcorp.com”
      revenue: “$40B”
      employees: “54,000”
      .. See Company schema section for more details
    }
  ]
}
{
  error: "Invalid or missing API authentication parameter(s)(API key/signature/epoch)"
}

IP to Company GET

This request is used to query the company details using an IP address.

Resource URL

http:/api.iprofile.net/ip.format Where format can be json OR xml

Input Schema

Name Type ..
api_key string required - E.g: XA323643Xaaa199329393
api_secret string required - E.g: shdjhfdhkfdhhf298749
ip_address string required - E.g: 63.100.100.5
domain string optional - E.g: tibco.com
company_name string optional - E.g: TIBCO Software
customer_request_id string optional - Client closure. Returned in the reply as it is.

Reply Schema

Name Type ..
status string Refer to the reply status section for more details
company hash Structure representing the company data
  company/(company fields)+ Refer to the Company schema section for details
ip_address string IP address provided in the request.
domain string The 'domain' parameter provided in the request.
company_name string The 'company_name' parameter provided in the request.
customer_request_id string The 'customer_request_id' parameter provided in the request.

HTTP Reply codes

Code Description
HTTP 200 OK Success
HTTP 401 Unauthorized Authentication failure.
HTTP 422 Unprocessable Entity Invalid or missing API input parameter(s).
HTTP 500 Internal Server Server error.

Reply Status codes

Status field Description
status found: The company is found.
not_found: The company is not found.
insufficient_input: The company search failed due to insufficient/invalid search parameters.

Sample Reply

{  
  status: “found”,
  customer_request_id: “c384309”,
  ip_address: “10.60.1.150”,
  company: {
    name: “Bar Technologies Corporation”,
    display_name: "Bar Technologies",
    url: “www.barcorp.com”
    revenue: “$40B”
    employees: “54,000”
    .. See Company schema section for more details
  }
}
{
  error: "Invalid or missing API authentication parameter(s)(API key/signature/epoch)"
}

Contact and Company schema

{
  first_name
  middle_name
  last_name
  email
  phone
  title
  rank
  department
  picture_url
  linkedIn_profile_url
  twitter_profile_url
  facebook_profile_url
  address: {
    address1
    address2
    city
    state
    zip
    country
    country_code
  }
  company: {
    Refer to the Company schema
  }  
}
{
  id
  name
  display_name
  ownership_type
  industry
  stock_ticker
  url
  phone  
  logo_url

  twitter_url
  linkedin_url
  facebook_url

  employees
  revenue
  it_budget      

  address
    address1
    address2
    city
    state
    zip
    country
    country_code
    latitude
    longitude

  # Represented as a hash, with category name as the key and an array of sub-category names as the value. 
  # Empty array is used when sub-category names are absent. E.g.:
  # {
  #  'Enterprise Applications' : [ 'CRM', 'ERP'],
  #  'Infrastructure and Systems' : [],
  #  'Middleware' : ['Application Integration']
  # }
  technology_categories 
    
  # Represented as a hash, with vendor name as key and an array of product names as value. Empty array is used when products are absent.
  vendors
    
}

Data Terms of Service

The Utilities API provides tools for data deduction which we use internally in our data processing workflow. Access to the API is free for up to 1,000 queries per day for non-commercial use only. To begin, browse the documentation.

How much does it cost and how do I purchase?

Pricing starts at $3 per thousand queries ($.003 per query). Contact sales@rapleaf.com if you are interested in access to this API.Fliptop's PeopleGraph transforms a humble email address or social ID into a complete digital identity for each of your contacts.

Using information available on the public web, PeopleGraph collects and matches social data from over 100 social networks such as Twitter, Facebook and LinkedIn and creates one unified digital personality for each of your leads and contacts.


Data Terms of Service

These terms and conditions are a legal agreement between you (“You” or “Client“) and iProfile, LLC (“iProfile,” “We” or “Us“). By accepting these terms and/or using the iProfile “LeadIQ API” or other Data Services we provide (collectively our “Data Services“), you represent that you have authority to bind the party being issued access to our Data Services, such as through a Passkey or Password (your “Account“) and otherwise act on their behalf (you and any such party are collectively referred to as “You“). In exchange for use of and access to our Data Services and/or their technical specifications (“Specifications“) you agree to be bound by these API and Data Terms of Service (this “Agreement“). This Agreement is supplemental to Your applicable end user license agreement or subscription agreement (the “Subscription Agreement”) regarding access to and use of the iProfile databases and subscription services covered in Your Subscription Agreement. As it relates to use of the LeadIQ API and Data Services, this Agreement takes precedence over and supersedes any prior agreement, whether oral or written, express or implied, between the parties, including any non-disclosure or confidentiality agreement.

1. Permission to Use

  • You may use iProfile’s Data Services and data you obtain from Us (“Data Services Data“) only in accordance with the terms and conditions of this Agreement, whether those Data Services are accessed (in our sole discretion) by you in automated fashion through connection to a web service, or through human input through a supported interface.
  • You are responsible for any and all use of Data Services by your Account. You agree to pay all charges arising from such use, pursuant to these or supplemental terms of payment that are included in your Subscription Agreement. You therefore agree not to share your Data Services Account password or passkey with any person who is not your agent or employee authorized to act on your behalf.
  • Subject to the terms of this Agreement and at our sole discretion, You may conduct queries for data as are facilitated through the API from time to time. If you want to query other data categories that are not facilitated through the API, please email us at info@iprofile.net. We will then provide you with a price list for further data query if available. Any priced data you obtain from us, at a charge, will be covered by this Agreement and Your Subscription Agreement, and subject to the same restrictions, along with further payment terms that both parties (We and You) must sign.

2. Length of Use

  • Your license does not allow you to store paid Data Services Data beyond the expiration of Your stated subscription term. You therefore agree to delete paid data received from Us upon expiration or termination of your Subscription Agreement. We reserve the right to ask you to certify in writing that you have complied with this requirement, and if we do so, you agree to comply.

3. Restrictions on Data You Receive From Us

  • Resale Prohibited. The Data Services Data may be used solely for your own internal business purposes. Except as otherwise permitted by Us in writing, You may not sell, lease, rent or except as otherwise set forth in this Agreement provide to any other party (i) the Data Services Data or a derivative of the Data Services Data, (ii) your own file, as enhanced with the supplemental data, or (iii) any direct marketing list, model, analysis, code, or report utilizing or derived from the Data Services Data.
  • If you wish to do any of the above, please contact us at info@iprofile.net regarding how you may become a reseller or channel provider.
  • Duty not to Interfere. You shall not interfere or attempt to interfere in any manner with the proper working of the Data Services.
  • Use of Data Services Data in Online Cookies Prohibited. You may not use, and may not authorize any third party to use, any Data Services Data for purposes of online targeted advertising, such as in online cookies.
  • Do Not “Guess.” You may only provide us with information you believe to be true and accurate. If we believe that you are using our Data Services to “guess” or otherwise extract information, we will terminate your account(s) immediately.
  • Restricted to Your Sales and Marketing Programs. The Data Services Data may solely be used for your sales and marketing programs to businesses, and is not intended for use as a general direct to consumer marketing tool.
  • Restricted Marketing Activities. Client shall not use any Data Services Data to advertise, sell, or exchange any products or services relating to illegal or illicit activities, including, without limitation, sexual products or services, drug products or services, pornographic materials, weapons, or involving credit repair services.
  • Communication Restrictions. All marketing communications used in connection with any list created by or for Client derived from the Data Services Data shall (i) be devoid of any reference to any selection criteria or presumed knowledge concerning the intended recipient of such solicitation, or the source of the recipient’s name and address; (ii) comply with all applicable federal and state laws, rules and regulations; and (iii) comply with all applicable privacy policies, ethical use and other industry standard practices that are generally observed in the business community at the time.
  • Furnish of Materials. Client agrees to furnish iProfile, if requested, samples of information derived from the Data Services Data that are used in your sales and marketing activities so that We may verify Your compliance with this Agreement.
  • Further Third Party Restrictions. You may not use the Data Services Data, in whole or in part, in the development of (i) any application that is outside the scope of this Agreement or (ii) any data products or services to be provided to third parties including, without limitation, any list enhancement data appending service or product.
  • Rights of Suppliers. To the extent iProfile is obligated to comply with certain restrictions and requirements placed upon the use of the Data Services Data by any relevant data suppliers or licensors, You shall strictly comply with all restrictions and requirements now or hereafter imposed upon iProfile by any Data Services Data supplier and made known to You in writing.
  • Information Safeguards. You represent and warrant that, Client has implemented and maintains an information security program that contains administrative, technical, and physical safeguards that are appropriate to its size and complexity the nature and scope of its activities, and the sensitivity of any customer information at issue.

4. Your Further Obligations

  • Security. You agree to use reasonable efforts to keep Data Services Data in a secure environment at all times according to commonly acceptable security standards for enterprise data, and in an environment at least as secure as that in which you keep your own confidential or proprietary data.
  • Compliance with Laws. In accepting and using the Data Services Data, you accept responsibility for complying with all applicable government laws, rules and regulations, and all third party rights. You will not submit customer data to us in a way that is inconsistent with any promises or representations you have made to your customers.
  • Business-to-Business Use Only. The iProfile Data Services and Data Services Data are intended for use in business-to-business marketing and sales activities, and are not provided for direct to consumer marketing activities or similar use. iProfile is not a consumer-reporting agency (“Consumer Reporting Agency”) as defined by the Fair Credit Reporting Act, 15 U.S.C. § 1681 et seq. (“FCRA”) and Data Services and reports do not constitute “Consumer Reports” as that term is defined in the FCRA. You agree to not use or provide the Data Services Data for any purposes enumerated in the FCRA in lieu of obtaining a Consumer Report.
  • IF YOU COLLECT INFORMATION FROM YOUR CUSTOMERS THROUGH ONLINE METHODS, YOU SHALL POST AND MAINTAIN A PRIVACY POLICY CONSISTENT WITH YOUR USE OF THE DATA SERVICES, THAT COMPLIES WITH APPLICABLE LAW AND SUFFICIENTLY DISCLOSES HOW YOU COLLECT AND SHARE USERS’ DATA WITH THIRD PARTIES. PLEASE CONSULT AN ATTORNEY IF YOU ARE UNSURE HOW TO DISCLOSE THIS INFORMATION IN A LEGAL AND APPROPRIATE MANNER.
  • Customer Inquiries and Suppression. You shall be responsible for accepting and responding to any communication initiated by your customers and prospects or their users arising out of Your use of the Data Services Data. You agree to provide “in house” suppression to any business contact obtained through the Data Services upon request by the individual or entity from future marketing initiatives by Client upon their request, and you agree to honor any such request by suppressing such contact information from your marketing and sales solicitations. No reference to iProfile in written or oral communications to a business contact or in scripts used by you in responding to customer inquiries shall be made without iProfile’s prior written approval.

5. PLEASE CAREFULLY REVIEW These Other Rights We Have, or That You Grant Us:

  • Monitoring. You agree that iProfile may monitor any Data Services activity to fulfill our obligations to You or under the law, or to ensure compliance with these terms.
  • Our Rights to Use Submission Data. In full or partial consideration for our providing Data Services Data to You, We may maintain in Our database a copy of the contact information or other data elements that you submit through the Data Services (“Submission Data”). You agree that we shall have the perpetual right to maintain, access, and use the Submission Data for our internal and commercial purposes, including for supplementing and including same into our Data Services databases and other database products in order to improve iProfile’s products and services.
  • We May Disclose Our Relationship With You for Our Marketing Purposes. You agree that we may use Your company’s name to identify Your company as a customer of iProfile, for our own marketing and/or promotional purposes.
  • Our Marks and Logos. Using the Data Services doesn’t give you permission to use any iProfile trademark, brand or logos. If you’d like to, please email us at info@iprofile.net.
  • Experimental Data Services. The availability of the Data Services, and the terms upon which it is available, are continually under experimentation and development. You acknowledge and agree that this Agreement does not create any estoppel, or other right to rely upon continued Data Services access, and you hereby waive, and agree not to assert, any such claims against iProfile under contract law or any other legal theory.
  • No Continued Access or Standard. We may suspend or terminate your access to the Data Services, or change any of the Data Services terms, licenses, Specifications, protocols or methods of access for any or no reason and will bear no liability for such decisions. It is solely your responsibility at all times to back-up your data and to be prepared to manage your accounts and conduct your business without access to the Data Services.
  • No Service Level. iPROFILE DOES NOT REPRESENT OR WARRANT, AND SPECIFICALLY DISCLAIMS, THAT THE DATA SERVICES WILL BE AVAILABLE WITHOUT INTERRUPTION OR WITHOUT BUGS.
  • Our Proprietary Rights and Your Limited License Rights. The Data Services and Data Services Data are the intellectual property and proprietary information of iProfile and our suppliers (if applicable). This Agreement does not grant You any intellectual property or other proprietary rights. You hereby release and covenant not to sue iProfile and its corporate affiliates and any of their licensees, assigns or successors, for any and all damages, liabilities, causes of action, judgments, and claims (a) pertaining to any intellectual property you develop that is based on, uses, or relates to the Data Services; or (b) which otherwise may arise in connection with your use of, reliance on, or reference to the Data Services Data. iProfile grants you a nonexclusive, non-transferable, non-sublicensable, revocable, limited license to install and use the object code we make available with the Data Services on any computer that you own or control. You may not charge any third party for using the Data Services, and you may not modify, adapt, reverse engineer (except as otherwise permitted by applicable law notwithstanding such limitation), decompile or attempt to discover the source code of the Data Services, or create any derivative works of the Data Services, or otherwise use the Data Services except as expressly provided in this Agreement.
  • iProfile reserves the right to review and pre-approve the Client’s intended use of the Data Services Data prior to iProfile’s acceptance of an order.

6. The Parties’ Additional Respective Legal Rights

  • Indemnification. You shall indemnify, defend and hold iProfile, its agents, affiliates, and licensors harmless from any claim, costs, losses, damages, liabilities, judgments and expenses (including reasonable fees of attorneys and other professionals), arising out of or in connection with any claim, action or proceeding (any and all of which are “Losses”) arising out of or related to any act or omission by you in using the Data Services or Data Services Data, or relating to the development, operation, maintenance, use and contents of the Data Services or Data Services Data, including but not limited to any infringement of any third-party proprietary rights or any liability for your improper or illegal use of the Data Services or Data Services Data. At iProfile’s option, You shall assume control of the defense and settlement of any Loss subject to indemnification by you (provided that, in such event, iProfile may at any time thereafter elect to take over control of the defense and settlement of any such Loss, and in any event, you shall not settle any such Loss without iProfile’s prior written consent).
  • Termination. Any licenses in this Agreement will terminate automatically without notice if you violate any provision of this Agreement. iProfile may terminate this Agreement or discontinue the Data Services or any portion or feature thereof for any or no reason and at any time without liability to you.
  • Modification. iProfile may modify any of the terms and conditions contained in this Agreement, at any time and in its sole discretion, by posting the change to this web page, posting a notice to your account, emailing to the email address of your account or otherwise notifying you. IF ANY MODIFICATION IS UNACCEPTABLE TO YOU, YOUR ONLY RECOURSE IS TO TERMINATE THIS AGREEMENT AND STOP USING THE DATA SERVICES. YOUR CONTINUED USE OF THE DATA SERVICES FOLLOWING A POSTING OR NOTIFICATION OF A CHANGE AS DESCRIBED ABOVE WILL CONSTITUTE YOUR BINDING ACCEPTANCE OF THE CHANGE.
  • Disclaimer and Limitation of Liability. The Data Services Data may be subject to transcription and transmission errors, accordingly, the Data Services Data is provided on an “as is,” “as available” basis. Any use or reliance upon the Data Services Data by Client shall be at its own risk. EXCEPT AS SET FORTH IN THIS SECTION, NEITHER iPROFILE NOR ANY DATA OWNER MAKES, AND EACH DISCLAIMS, ANY WARRANTIES, EXPRESS OR IMPLIED, HEREUNDER WITH RESPECT TO THE DATA SERVICES, DATA SERVICES DATA, OR THE MEDIA ON WHICH THE DATA SERVICES DATA IS PROVIDED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF ACCURACY, COMPLETENESS, CURRENTNESS, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. iPROFILE’S AGGREGATE LIABILITY TO CLIENT, WHETHER FOR NEGLIGENCE, BREACH OF WARRANTY, OR ANY OTHER CAUSE OF ACTION, SHALL BE LIMITED TO THE PRICE PAID FOR THE DATA SERVICES DATA OR DATA SERVICES TO WHICH THE INCIDENT RELATES. IN NO EVENT SHALL iPROFILE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES, WHETHER OR NOT FORESEEABLE AND HOWEVER ARISING, INCLUDING BUT NOT LIMITED TO LOST INCOME OR LOST REVENUE, WHETHER BASED IN CONTRACT, TORT OR ANY OTHER THEORY.
  • Injunctive Relief. You agree that the limitations and restrictions in this Agreement are necessary and reasonable to protect iProfile, and that monetary damages may not be a sufficient remedy for breach of this Agreement. You therefore agree not to assert, with respect to an action or motion of iProfile for injunctive relief with respect to such breach, that monetary damages would be sufficient remedy for such a breach. You agree that iProfile will be entitled to seek temporary and permanent injunctive relief against any threatened violation of such limitations or restrictions or the continuation of any such violation in any court of competent jurisdiction, without having to prove actual damages.
  • Construction of These Terms. This Agreement is governed by Texas law except for its conflicts of laws principles and must be adjudicated in Travis County, Texas. This is the entire agreement between the parties with respect to its subject matter. This Agreement is entered into solely to benefit You and iProfile: there are no third party beneficiaries to it. Any conflicting or additional terms contained in additional documents or oral discussions are void (except for written agreement signed by both parties). You may not assign any of your rights hereunder and any such attempt is void. iProfile may assign this agreement to a successor by way of merger, consolidation, or sale of all or substantially all of its assets to an entity that assumes the business activities that are the subject of this Agreement. You and iProfile are not legal partners or agents, but are independent contractors.