Skip to content

Latest commit

 

History

History
52 lines (32 loc) · 2.55 KB

README.md

File metadata and controls

52 lines (32 loc) · 2.55 KB
Raw

EnrichedProfile

(enriched_profile)

Overview

By supplying an email address, you can retrieve a profile with enriched data fields. This service is offered in collaboration with Clearbit.

Available Operations

get_enrichment_profile

Fetch enriched profile data. Requires a valid email address. This service is offered in collaboration with Clearbit.

To use this endpoint from the browser, you'll need to specify the /profile-enrichment.read scope when generating a token.

Example Usage

from moov import Moov
import os

s = Moov(
    gateway_auth=os.getenv("MOOV_GATEWAY_AUTH", ""),
)

res = s.enriched_profile.get_enrichment_profile(email="employee@business.com")

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
email str ✔️ Valid email address belonging to the profile of interest
 employee@business.com
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.GetEnrichmentProfileResponse

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*