opportify-sdk-java

Opportify Insights API

• API version: 0.6.1
  • Build date: 2026-01-31T14:35:15.553092-08:00[America/Los_Angeles]
  • Generator version: 7.12.0

The Opportify Insights API provides access to a powerful and up-to-date platform. With advanced data warehousing and AI-driven capabilities, this API is designed to empower your business to make informed, data-driven decisions and effectively assess potential risks.

Use the following base URL for all API requests:

https://api.opportify.ai/insights/v1/<service>/<endpoint>

• Email Insights:

  • Validate email syntax.
  • Identify email types (free, disposable, private or unknown).
  • Real time verifications:
    • Reachable: Confirms if the email domain has valid MX DNS records using DNS lookup.
    • Deliverable: Simulates an SMTP handshake to check if the email address exists and is deliverable.
    • Catch-All: Detects if the domain accepts all emails (catch-all configuration).
  • Intelligent Error Correction: Automatically corrects well-known misspelled email addresses.
  • Risk Report: Provides an AI-driven normalized score (200-1000) to evaluate email risk, using predefined thresholds.

  Access Documentation >>

• IP Insights:

  • Connection types: Detects connection types such as wired, mobile, enterprise, satellite, VPN, cloud-provider, open-proxy, or Tor.
  • Geo location: Delivers detailed insights such as country, city, timezone, language preferences, and additional location-based information to enhance regional understanding.
  • WHOIS: Provides main details including RIR, ASN, organization, and abuse/admin/technical contacts.
  • Trusted Provider Recognition: Identifies if the IP is part of a known trusted provider (e.g., ZTNA - Zero Trust Network Access).
  • Blocklist Reports: Retrieves up-to-date blocklist statuses, active reports, and the latest detections.
  • Risk Report: Delivers an AI-driven normalized score (200-1000) to evaluate IP risk, supported by predefined thresholds.

  Access Documentation >>

• API Key: Access to the API requires an API key, which must be included in the request headers. Businesses can generate unlimited API keys directly from their account, offering flexibility and ease of use.
• ACL Rules: Enhance security with Access Control Lists (ACL), allowing you to restrict API access from specific IP addresses or ranges. This feature provides an additional layer of protection by ensuring only authorized IPs can interact with the API.
• No Query Parameters: As a precautionary measure, our API avoids the use of query parameters for all operations, including authentication and handling Personally Identifiable Information (PII). This approach minimizes security risks by preventing sensitive data from being exposed in access logs, browser history, cached URLs, debugging tools, or inadvertently shared URLs. All sensitive information is securely transmitted through headers or the request body.

Automatically generated by the OpenAPI Generator

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Add this dependency to your project's POM:

<dependency>
  <groupId>ai.opportify</groupId>
  <artifactId>opportify-sdk-java</artifactId>
  <version>0.6.1</version>
  <scope>compile</scope>
</dependency>

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'opportify-sdk-java' jar has been published to maven central.
    mavenLocal()       // Needed if the 'opportify-sdk-java' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "ai.opportify:opportify-sdk-java:0.6.1"
  }

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/opportify-sdk-java-0.6.1.jar
• target/lib/*.jar

Please follow the installation instruction and execute the following Java code:

// Import classes:
import ai.opportify.client.ApiClient;
import ai.opportify.client.ApiException;
import ai.opportify.client.Configuration;
import ai.opportify.client.auth.*;
import ai.opportify.client.model.*;
import ai.opportify.client.api.EmailInsightsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.opportify.ai/insights/v1");
    
    // Configure API key authorization: opportifyToken
    ApiKeyAuth opportifyToken = (ApiKeyAuth) defaultClient.getAuthentication("opportifyToken");
    opportifyToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //opportifyToken.setApiKeyPrefix("Token");

    EmailInsightsApi apiInstance = new EmailInsightsApi(defaultClient);
    AnalyzeEmailRequest analyzeEmailRequest = new AnalyzeEmailRequest(); // AnalyzeEmailRequest | 
    try {
      AnalyzeEmail200Response result = apiInstance.analyzeEmail(analyzeEmailRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EmailInsightsApi#analyzeEmail");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

All URIs are relative to https://api.opportify.ai/insights/v1

• AbuseContact
• AddressSignals
• AdminContact
• AnalyzeEmail200Response
• AnalyzeEmail400Response
• AnalyzeEmail403Response
• AnalyzeEmail500Response
• AnalyzeEmailRequest
• AnalyzeIp200Response
• AnalyzeIp400Response
• AnalyzeIpRequest
• Asn
• BatchAnalyzeEmails202Response
• BatchAnalyzeEmails400Response
• BatchAnalyzeEmails401Response
• BatchAnalyzeEmails402Response
• BatchAnalyzeEmails403Response
• BatchAnalyzeEmails413Response
• BatchAnalyzeEmails429Response
• BatchAnalyzeEmailsRequest
• BatchAnalyzeIps202Response
• BatchAnalyzeIps400Response
• BatchAnalyzeIpsRequest
• BlockListed
• CreateEmailBatchExport400Response
• CreateEmailBatchExport400ResponseOneOf
• CreateEmailBatchExport403Response
• CreateEmailBatchExport404Response
• CreateEmailBatchExport409Response
• EXPORTNOTFOUND
• EmailDNS
• EmailDomain
• ExportCreatedResponse
• ExportFilter
• ExportRequest
• ExportStatusResponse
• FORBIDDEN
• Geo
• GetEmailBatchExportStatus400Response
• GetEmailBatchExportStatus404Response
• GetEmailBatchStatus200Response
• GetEmailBatchStatus200ResponseDownloadUrls
• GetEmailBatchStatus404Response
• GetIpBatchStatus200Response
• INTERNALERROR
• INVALIDDATA
• INVALIDEMAIL
• INVALIDPLAN
• INVALIDTOKEN
• IPVALIDATIONFAILED
• JOBNOTFOUND
• JOBNOTREADY
• MALFORMEDREQUEST
• MANIFESTNOTAVAILABLE
• NOTFOUND
• Organization
• QUOTAEXCEEDED
• RiskReportEmail
• RiskReportIp
• TOOMANYREQUESTS
• TechContact
• TrustedProvider
• Whois

Authentication schemes defined for the API:

• Type: API key
• API key parameter name: x-opportify-token
• Location: HTTP header

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.