Quick Start
This page will help you get started with Enrich API.
Authentication
The Enrich API is a set of HTTPS endpoints you can use to programmatically fetch from our SMARTe database and add into your existing technology stack and workflows. The input and response are in JSON format which is commonly used to support most of the CRMs and MAPs.
URL
POST https://api.smarte.pro/v7/enrich
Headers
Below are the mandatory input parameter to call Enrich API.
API Key
All API calls must include a valid API key. This is our way of authenticating your call. API key will be required as a part of request header. The API key can also be sent in the JSON body. We support both ways of validating the access token.
"apikey": "<keyname>"
Enrichment Rules
Enrichment will be performed based on Subscription Type. The Subscription type is determined by your organization's contract value and use cases.
There are three Subscription Type i.e.
- Enterprise Standard: This includes company, contact, and email information.
- Enterprise Plus: In addition to the features of Enterprise Standard, Enterprise Plus includes:
- Direct Dial Numbers
- Current employment information for ‘No Longer’ status records (contacts who have left the organization)
- No cost refresh for previously processed records
- Pro: In addition to the features of Enterprise Standard, Pro (with limited credits) includes:
- Direct Dial Numbers
- Current employment information for ‘No Longer’ status records (contacts who have left the organization)
- Both enrichment will cost 1 credit
This is how your request headers will look:
"content-type": "application/json"
"apikey": "<key_name>"
The application/json is required as well to submit your data in JSON format.
Input Field Requirement
It's best to provide as much info as possible. Try passing all the available input fields of company and contacts for better match rate and enrichment.
Below is the sample input request. Here's how you would do that using a simple HTTP POST request using curl
command.
curl --request POST \
--url 'https://api.smarte.pro/v7/enrich' \
--header 'apikey: 43f554rr-351a-387r-b533-38b0000xxxxx' \
--header 'content-type: application/json' \
--data '{"recordId": "123a456b",
"companyName": "Smarte, Inc",
"companyWebAddress":"www.smarteinc.com",
"contactFullName": "Parul Gala",
"contactFirstName": "",
"contactLastName": "",
"contactMiddleName": "",
"contactEmail": "parul.gala@smarteinc.com",
"contactJobTitle": "VP",
"contactCountry": “USA"
}'
Results
Based on your inputs the system will find the best possible match and share it as response.
{
"accuracy": "A+",
"compAddr": "1101, Vishwaroop IT Park; Sector 30A, Vashi",
"compCity": "Navi Mumbai",
"compCountry": "India",
"compEmpCount": "534",
"compEmpRange": "501 to 1000",
"compParentGuid": "6003CDF9BFAFA261",
"compGUID": "A3331FBAD0A58C5E",
"compGlobalHqParentGuid": "6003CDF9BFAFA261",
"compGlobalRegions": "South Asia | Asia | APAC",
"compIndustry": "Software Development",
"compLegalStatus": "Privately Held",
"compNaicsCodes": "5112 | 51121 | 511210",
"compNaicsDescription": "5112 - Software Publishers | 51121 - Software Publishers | 511210 - Software Publishers",
"compName": "SMARTe",
"compNameAka": "SMARTe",
"compPhoneNo": "+91 22 6838 4000",
"compPubProfileUrl": "https://www.linkedin.com/company/smarte-inc",
"compRevRange": "$100 - 250M",
"compSicCodes": "5045 | 7372 | 504599 | 737299 | 50459903 | 73710301",
"compSicDescription": "5045 - Computers, Peripherals, And Software | 7372 - Prepackaged Software | 504599 - Computers, Peripherals, And Software, Nec | 737299 - Prepackaged Software, Nec | 50459903 - Computer Software | 73710301 - Computer Software Development",
"compState": "Maharashtra",
"compWebsite": "smarteinc.com",
"compWorldwideParentName": "SMARTe",
"compZipcode": "400703",
"conEmail": "parulxxxxx@smarteinc.com",
"conFirstName": "Parul",
"conFullName": "Parul Gala",
"conFunctions": "Engineering and Development",
"conGUID": "70613C451D330F983EC47EF12ADF1F7D",
"conJobStartedOn": "Oct-2009",
"conJobTitleEn": "VP of Products and HR",
"conJobUpdatedOn": "Oct-2009",
"conLastName": "Gala",
"conLevels": "VP",
"conLoc": "India",
"conPubProfileUrl": "https://www.linkedin.com/in/parulgala",
"conSubFunctions": "Product Management",
"conWorkLocAddr": "1101, Vishwaroop IT Park; Sector 30A, Vashi",
"conWorkLocCity": "Navi Mumbai",
"conWorkLocCountry": "India",
"conWorkLocPhoneNo": "+91 22 6838 4000",
"conWorkLocState": "Maharashtra",
"conWorkLocZipcode": "400703",
"recordId": "123a456b",
"recordStatus": "active",
"smarteTransactionId": "c96aced8-dfb2-4751-b56e-93d86a048e18",
"directDial1": "+1 408-396-XXXX",
"directDial2": "+1 650-245-XXXX"
}