Package io.moov.sdk

Class EnrichedProfile

java.lang.Object

io.moov.sdk.EnrichedProfile

All Implemented Interfaces:

SDKMethodInterfaces.MethodCallGetEnrichmentProfile

public class EnrichedProfile
extends java.lang.Object
implements SDKMethodInterfaces.MethodCallGetEnrichmentProfile

Method Summary

Modifier and Type	Method	Description
GetEnrichmentProfileRequestBuilder	get()	Fetch enriched profile data.
GetEnrichmentProfileResponse	get(java.lang.String email)	Fetch enriched profile data.
GetEnrichmentProfileResponse	get(java.util.Optional<java.lang.String> xMoovVersion, java.lang.String email)	Fetch enriched profile data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

get

public GetEnrichmentProfileRequestBuilder get()

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

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/profile-enrichment.read` scope.

Returns:

The call builder

get

public GetEnrichmentProfileResponse get(java.lang.String email)
                                 throws java.lang.Exception

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

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/profile-enrichment.read` scope.

Parameters:

email -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails

get

public GetEnrichmentProfileResponse get(java.util.Optional<java.lang.String> xMoovVersion,
                                        java.lang.String email)
                                 throws java.lang.Exception

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

To access this endpoint using an [access token](https://docs.moov.io/api/authentication/access-tokens/) you'll need to specify the `/profile-enrichment.read` scope.

Specified by:

get in interface SDKMethodInterfaces.MethodCallGetEnrichmentProfile

Parameters:

xMoovVersion - Specify an API version. API versioning follows the format `vYYYY.QQ.BB`, where - `YYYY` is the year - `QQ` is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10) - `BB` is the build number, starting at `.01`, for subsequent builds in the same quarter. - For example, `v2024.01.00` is the initial release of the first quarter of 2024. The `latest` version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

email -

Returns:

The response from the API call

Throws:

java.lang.Exception - if the API call fails