irisnet-java-client

Irisnet API

• API version: v2
  • Generator version: 7.11.0

Artificial Intelligence (AI) for image- and video-processing in real-time. This is an interactive documentation where you can quickly look up the endpoints and their schemas, while having the opportunity to try things out for yourself.

In the list below, you can see the available endpoints of the API, which can be expanded by clicking on them. Each expanded endpoint lists the request parameters (if available) and the request body (if available). The request body can list some example bodies and the schema, explaining each model in detail.

Additionally you'll find a 'Try it out' button that allows you to enter your custom parameters and custom body and execute that against the API. Be sure to enter your license key to authorize the requests before using this documentation interactively.

The responses section in the expanded endpoint lists the possible responses with their corresponding status codes. If you've executed an API call it will also show you the response from the server.

Underneath the endpoints you'll find the model schemas. These are the models used for the requests and responses. If you click on the right arrow, you can expand the model and get a description of the model and the model parameters. For nested models, you can keep clicking the right arrow for further details.

Clicking the link below the title at the top of this page opens the OpenAPI specification (OAS3) in JSON format. The OAS3 Spec allows the generation of clients in many programming languages. There are several free client generators available that can be used to get started easily.

For more information, please visit https://shop.airisprotect.com

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

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

Installation

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.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>de.irisnet.java.client</groupId>
  <artifactId>irisnet-java-client</artifactId>
  <version>3.7.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

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

  dependencies {
     implementation "de.irisnet.java.client:irisnet-java-client:3.7.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/irisnet-java-client-3.7.0.jar
• target/lib/*.jar

Getting Started

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

// Import classes:
import de.irisnet.java.ApiClient;
import de.irisnet.java.ApiException;
import de.irisnet.java.Configuration;
import de.irisnet.java.auth.*;
import de.irisnet.java.client.model.*;
import de.irisnet.java.client.AiCheckOperationsApi;

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

    AiCheckOperationsApi apiInstance = new AiCheckOperationsApi(defaultClient);
    UUID configId = UUID.randomUUID(); // UUID | The configuration id from the Basic Configuration operations.
    DocumentCheckRequestData documentCheckRequestData = new DocumentCheckRequestData(); // DocumentCheckRequestData | The DocumentCheckRequestData containing data needed for the id document check.
    try {
      CheckResult result = apiInstance.checkIdDocument(configId, documentCheckRequestData);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AiCheckOperationsApi#checkIdDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.irisnet.de

Class	Method	HTTP request	Description
AiCheckOperationsApi	checkIdDocument	POST /v2/check-id-document/{configId}	Check an id document with the AI.
AiCheckOperationsApi	checkImage	POST /v2/check-image/{configId}	Check an image with the AI.
AiCheckOperationsApi	checkStream	POST /v2/check-stream/{configId}	Check a stream with the AI.
AiCheckOperationsApi	checkVideo	POST /v2/check-video/{configId}	Check a video with the AI.
AiCheckOperationsApi	liveDocumentCheck	POST /v2/check-live-id-document/{configId}	Start a guided live id document check with the AI.
BalanceEndpointsApi	getCost	GET /v2/cost/{configId}	Get the cost of the configuration for a single image.
BalanceEndpointsApi	getLicenseInfo	GET /v2/info/	Get information for the given license key.
BalanceEndpointsApi	getVideoCost	GET /v2/cost/{configId}/{frames}	Get the cost of the configuration for moving images.
BalanceEndpointsApi	getVideoCost1	GET /v2/cost/{configId}/{fps}/{duration}	Get the cost of the configuration for moving images.
ConfigurationManagementApi	deleteConfig	DELETE /v2/config/{configId}	Delete an AI configuration.
ConfigurationManagementApi	getAllConfigs	GET /v2/config/	List all saved AI configurations.
ConfigurationManagementApi	getConfig	GET /v2/config/{configId}	Get a specific AI configuration.
ConfigurationManagementApi	setConfig	POST /v2/config/	Create a new AI configuration.
DetailedConfigurationParametersApi	clearParameters	DELETE /v2/config/parameters/{configId}	Delete the parameters of the AI configuration.
DetailedConfigurationParametersApi	getParameters	GET /v2/config/parameters/{configId}	Get the parameters of the AI configuration.
DetailedConfigurationParametersApi	setParameters	POST /v2/config/parameters/{configId}	Set parameters to the given AI configuration.

Documentation for Models

• AgeEstimationAttribute
• AgeEstimationDetection
• AgeEstimationSubChecks
• ApiNotice
• BaseAttribute
• BaseDetection
• BreastDetection
• BrokenRule
• Callback
• CheckResult
• Config
• Coordinates
• Data
• Detection
• DocumentCheckRequestData
• Encoded
• Event
• FaceDetection
• HairAttribute
• HairDetection
• IdDocumentAttribute
• IdDocumentDetection
• IdDocumentSubChecks
• KnownFace
• KycUiParameter
• LicenseInfo
• LiveDocumentCheckRequestData
• LiveDocumentCheckResponseData
• Param
• ParamSet
• Pricing
• Rectangle
• Summary

Documentation for Authorization

Authentication schemes defined for the API:

LICENSE-KEY

• Type: API key
• API key parameter name: LICENSE-KEY
• Location: HTTP header

Recommendation

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

Author

[email protected]