API Reference
Complete API reference documentation with request parameters, response fields, and status codes for the SMARTe enrichment API.
Request parameters
Below are the input fields that are supported:
| Parameter | Data Type |
|---|---|
| recordId | String |
| compName | String |
| compWebsite | String |
| conFullName | String |
| conFirstName | String |
| conLastName | String |
| conEmail | String |
| country | String |
| conJobTitle | String |
| compLinkedinUrl | String |
| conLinkedinUrl | String |
| compGuid | String |
| conGuid | String |
- For company enrichment use company parameters such as
compNameorcompWebsiteORcompLinkedinUrlORcompGuid - For contact enrichment use combination of contact and company parameters together, such as following combinations
conFullNameAND (compNameORcompWebsite)- (
conFirstNameANDconLastName) AND (compNameORcompWebsite) conEmailconLinkedinUrlconGuid
- More the combinations, more the matches
Response parameters
Below are the output fields:
| Parameter | Data Type | Description |
|---|---|---|
| recordID | String | Unique identifier of the input record used to retrieve the data. |
| recordStatus | String | Status of the record (e.g., Active, No Longer, No Match). |
| accuracy | String | Accuracy rating for the matched record (A+, A, A-, B where A+ is highest). |
| compGUID | String | Unique 16-digit alphanumeric identifier for the company in the SMARTe database. |
| compName | String | Standard company name. |
| compNameAka | String | Alternate company names or aliases (DBA, also known as). |
| compStockSymbol | String | Company stock ticker symbol. |
| compStockExchangeCode | String | Stock exchange code where the company is listed. |
| compPhoneNo | String | Company phone number. |
| compAddr | String | Company street address. |
| compCity | String | City of the company. |
| compIsMnc | String | Indicates whether the company is a multinational corporation. |
| compMetroArea | String | Metropolitan area of the company. |
| compState | String | State or region of the company. |
| compCountry | String | Country of the company. |
| compCountryIsoCode2 | String | Two-letter ISO country code for the company country. |
| compZipcode | String | Postal or ZIP code of the company. |
| compGlobalRegions | String | Global geographic region where the company operates. |
| compWebsite | String | Official website of the company. |
| compParentGuid | String | Unique identifier of the parent company. |
| compParentName | String | Name of the parent company. |
| compParentCountry | String | Parent company country. |
| compParentCountryIsoCode2 | String | Two-letter ISO country code for the parent company. |
| compWorldwideParentGuid | String | Unique identifier of the ultimate worldwide parent company. |
| compWorldwideParentName | String | Name of the ultimate worldwide parent company in the corporate hierarchy. |
| compWorldwideParentCountry | String | Country where the worldwide parent company is headquartered. |
| compWorldwideParentCountryIsoCode2 | String | Two-letter ISO country code of the worldwide parent company. |
| compRevRange | String | Revenue range of the company. |
| compRevenue | String | Absolute company revenue. |
| compGrossProfitInUsd | String | Company gross profit in USD. |
| compOperatingIncomeInUsd | String | Company operating income in USD. |
| compNetIncomeInUsd | String | Company net income in USD. |
| compMarketCapInUsd | String | Company market capitalization in USD. |
| compFiscalYearEndMonth | String | Month when the company fiscal year ends. |
| compTotalFunding | String | Total funding amount raised by the company. |
| compTotalFundingRounds | String | Total number of funding rounds received by the company. |
| compLastFundingRound | String | Type of the company’s most recent funding round. |
| compLastFundingDate | String | Date of the most recent funding round. |
| compEmpCount | String | Total number of employees in the company. |
| compEmpRange | String | Employee size range of the company. |
| compIndustry | String | Industry or industries in which the company operates. |
| compSicCodes | String | SIC codes for the company. |
| compSicDescription | String | Description of the company’s SIC classification. |
| compNaicsCodes | String | NAICS codes for the company. |
| compNaicsDescription | String | Description of the company’s NAICS classification. |
| compIsSubsidiary | String | Indicates whether the company operates as a subsidiary. |
| compLegalStatus | String | Legal status of the company (e.g., Public, Private). |
| compFoundingYear | String | Year the company was founded. |
| compPubProfileUrl | String | Public LinkedIn profile URL of the company. |
| conGUID | String | Unique 32-digit alphanumeric identifier for the contact in the SMARTe database. |
| conFullName | String | Full name of the contact person. |
| conFirstName | String | First name of the contact. |
| conMiddleName | String | Middle name of the contact. |
| conLastName | String | Last name of the contact. |
| conEmail | String | Contact email address. |
| conJobTitle | String | Current job title of the contact at the company. |
| conLevels | String | Contact seniority level (e.g., VP, Director, Manager). |
| conFunctions | String | Primary functional department of the contact (e.g., Sales, Marketing, IT). |
| conSubFunctions | String | Specific functional specialization within the department. |
| conJobStartedOn | String | Month and year when the contact started their current role. |
| conJobPromotedOn | String | Date when the contact was promoted to their current role. |
| mobileNumber | String | Mobile phone number of the contact. |
| directDial | String | Direct phone number of the contact. |
| conWorkLocAddr | String | Work location street address of the contact. |
| conWorkLocCity | String | Work location city of the contact. |
| conWorkLocArea | String | Work location metropolitan area of the contact. |
| conWorkLocState | String | Work location state or region of the contact. |
| conWorkLocZipcode | String | Work location postal or ZIP code of the contact. |
| conWorkLocPhoneNo | String | Work location phone number of the contact. |
| conWorkLocCountry | String | Work location country of the contact. |
| conLoc | String | Contact LinkedIn location (e.g., Greater San Francisco Bay Area). |
| conPubProfileUrl | String | Public LinkedIn profile URL of the contact. |
| smarteTransactionId | String | Unique SMARTe transaction identifier associated with the record request. |
| 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 |
Updated about 4 hours ago
What’s Next
