Getting Started

Authentication Method

SMARTe supports following authentication mechanisms:

API Key authentication for server-to-server and batch workflows.

Follow this guide to secure API access using supported auth methods.

Select an Enrichment Endpoint

Choose the endpoint based on your enrichment use case:

Endpoint	Description
/v8/enrich/person	Use for contact and lead enrichment
/v8/enrich/company	Use for account and company enrichment
/v8/enrich/email	Use for only email enrichment
/v8/enrich/mobile	Use for only mobile/direct dial enrichment
/v8/enrich/funding	Use for only funding enrichment
/v8/enrich/technographics	Use for only technographics enrichment
/v8/enrich	Use a single endpoint when you need to support multiple enrichment behaviors using output mode value.

Select an Output Mode

SMARTe Enrich APIs use output modes to control the response payload. Choose the data you want returned in the response.

Available output modes are:

Output Mode	Returns
Limited (Ltd)	Core enriched fields for person and company
Email	Email fields only
Mobile	Phone and direct dial fields only
Funding	Funding and investment data only
Technographics	Technographics fields only

The output mode values are set when single enrich endpoint (/v8/enrich) is used.

Send Your First API Request

Sample request using the Person Enrich API:

curl --request POST \
  --url https://api.smarte.pro/v8/enrich/person \
  --header 'apikey: <key>' \
  --header 'Content-Type: application/json' \
  --data '{
    "recordId": "rec-123",
    "email": "[email protected]",
    "linkedinUrl": "https://linkedin.com/in/johndoe",
    "companyName": "Example Corp",
    "companyWebsite": "example.com"
  }

Review the Response

Each response includes:

An enrichment status indicating the outcome
Enriched data based on the selected scope and output mode
A smarteTransactionId for traceability

Credits are deducted only if enrichment data is successfully returned.

API Reference

Explore endpoints, inputs, and responses.