Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 10.3 KB

README.md

File metadata and controls

68 lines (47 loc) · 10.3 KB

EnrichedProfile

(enrichedProfile())

Overview

Available Operations

  • 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 you'll need to specify the /profile-enrichment.read scope.

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 you'll need to specify the /profile-enrichment.read scope.

Example Usage

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetEnrichmentProfileResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetEnrichmentProfileResponse res = sdk.enrichedProfile().get()
                .xMoovVersion("v2024.01")
                .email("Sheldon.Effertz@gmail.com")
                .call();

        if (res.enrichedBusinessProfile().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
xMoovVersion Optional<String> 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 an optional build number starting at .01 for subsequent builds in the same quarter.
- If no build number is specified, the version refers to the initial release of the quarter.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
email String ✔️ N/A

Response

GetEnrichmentProfileResponse

Errors

Error Type Status Code Content Type
models/errors/APIException 4XX, 5XX */*