API Reference

Request parameters

Below are the input fields that are supported:

Parameter	Data Type
recordId	String
companyName	String
companyWebAddress	String
contactFullName	String
contactFirstName	String
contactLastName	String
contactMiddleName	String
contactEmail	String
contactCountry	String
contactJobTitle	String
companyLnUrl	String
contactUrl	String
companyGuid	String
contactGuid	String

• For company enrichment use company parameters such as <companyName> or <companyWebAddress> OR <companyLnUrl> OR <companyGuid>
• For contact enrichment use combination of contact and company parameters together, such as following combinations
  • <contactFullName> AND (<companyName> OR <companyWebAddress>)
  • (<contactFirstName> AND <contactLastName>) AND (<companyName> OR <companyWebAddress>)
  • <contactEmail>
  • <contactUrl>
  • <contactGuid>
• More the combinations, more the matches

Response parameters

Below are the output fields:

Parameter	Data Type	Description
recordId	String	Input record id that was used to fetch this information.
recordStatus	String	This field provides the status of the record whether Active, No Longer, No Match, etc.
accuracy	String	Accuracy provided against the recordStatus of the record. it has 4 values i.e. A+, A, A-, B. in which A+ is highest rated and B is lowest rated.
compGUID	String	Unique 16 digit alphanumeric id assigned to a Company in our SMARTe repository.
compName	String	Standard Company Name.
compNameAka	String	Company Name Variations (Also known as, Doing Business As, etc).
compPhoneNo	String	Company HQ Phone Number.
compAddr	String	Company HQ address.
compCity	String	Part of Company HQ address.
compState	String	Part of Company HQ address.
compCountry	String	Part of Company HQ address.
compZipcode	String	Part of Company HQ address.
compGlobalRegions	String	Part of Company HQ address.
compWebsite	String	Standard Company Website.
compParentName	String	Parent Company Name.
compWorldwideParentName	String	Head of the family tree of companies.
compGlobalHqParentGuid	String	Worldwide Parent Company Guid.
compParentGuid	String	Parent Company Guid.
compRevRange	String	SMARTe Company Revenue Range.
compEmpRange	String	SMARTe Company Employee Range.
compEmpCount	String	SMARTe Company Employee Count.
compIndustry	String	SMARTe Company Industry List.
compSicCodes	String	Company SIC Codes.
compSicDescription	String	Company SIC Description.
compNaicsCodes	String	Company NAICS Codes.
compNaicsDescription	String	Company NAICS Description.
compIsSubsidiary	String	Is Company Subsidiary or not.
compLegalStatus	String	Company Legal Status. (Ex. Public, Private, etc.).
compFoundingYear	String	Company Founding Year.
compPubProfileUrl	String	Company LinkedIn Public Profile URL.
conGUID	String	Unique 32-digit alphanumeric id assigned to a company in Smarte database.
conFullName	String	Contact Full Name.
conFirstName	String	Contact First Name.
conMiddleName	String	Contact Middle Name.
conLastName	String	Contact Last Name.
conEmail	String	Contact seniority like VP, Director, Manager, etc.
conJobTitleEn	String	Contact Job Title.
conLevels	String	Contact Job Level like VP, Director, Manager.
conSubFunctions	String	Contact sub-departments within department like IT Development, IT Operations, etc.
conFunctions	String	Contact department like Sales, Marketing, IT, etc.
conJobUpdatedOn	String	Month and year when a person received an internal promotion or experienced departmental changes.
conJobStartedOn	String	Month and year when the person joined the current company.
conWorkLocAddr	String	Contact Location Address.
conWorkLocCity	String	Contact Location Address.
conWorkLocState	String	Contact Location Address.
conWorkLocCountry	String	Contact Location Address.
conWorkLocZipcode	String	Contact Location Address.
conWorkLocPhoneNo	String	Contact Location Phone.
conLoc	String	Contact LinkedIn location like Greater San Francisco bay Area, Greater Austin Area, etc.
conPubProfileUrl	String	Contact LinkedIn Public Profile URL.
directDial1	String	Direct Number of the Lead.
directDial2	String	Alternate Direct Number of the Lead.
smarteTransactionId	String	SMARTe unique transaction ID for that record.
currentTenure	Object	If the record status is no longer, new tenure information with all listed fields will be shared.

Response Status Code

Based on request data and system state, these are the possible Status codes that you may come across.

HTTP Status Code	Message	Error Description
200	Ok	Successful Request
400	Bad Request	Invalid API key
401	Unauthorized	Missing input parameters
403	Forbidden
412	Precondition Failed	No Credits Available
429	Throttled Out	You have been rate limited
500	Internal Server Error
502	Bad Gateway
503	Service Unavailable
408/504	Request Timeout /Gateway Timeout