irisnet-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

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

mvn install

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

mvn deploy

Refer to the official documentation 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>4.1.6</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "de.irisnet.java.client:irisnet-java-client:4.1.6"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

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

Getting Started

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

import de.irisnet.java.client.AICheckOperationsApi;

public class AICheckOperationsApiExample {

    public static void main(String[] args) {
        AICheckOperationsApi apiInstance = new AICheckOperationsApi();
        UUID configId = null; // UUID | The configuration id from the Basic Configuration operations.
        BiometricCheckRequestData biometricCheckRequestData = {"callback":{"callbackUrl":"https://www.example.com/callback?ageestimation"},"selfieImage":"/9j/4AAQSkZJRgABAQEASABIAAD..."}; // BiometricCheckRequestData | The BiometricCheckRequestData containing data needed for the age verification check.
        try {
            CheckResult result = apiInstance.ageVerification(configId, biometricCheckRequestData);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AICheckOperationsApi#ageVerification");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
AICheckOperationsApi	ageVerification	POST /v2/age-verification/{configId}	Perform an age verfication check for a given selfie with the AI.
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	checkPoaDocument	POST /v2/check-poa-document/{configId}	Perform a proof of address check with the AI.
AICheckOperationsApi	checkStream	POST /v2/check-stream/{configId}	Check a stream with the AI.
AICheckOperationsApi	checkText	POST /v2/check-text/{configId}	Check a text with the AI.
AICheckOperationsApi	checkVideo	POST /v2/check-video/{configId}	Check a video with the AI.
AICheckOperationsApi	faceAuthentication	POST /v2/face-authentication/{configId}	Perform a face authentication for a given selfie 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

• AgeVerificationAttribute
• AgeVerificationDetection
• AgeVerificationSubChecks
• AiClassification
• AiPrototype
• ApiNotice
• Attribute
• BaseAttribute
• BaseDetection
• BiometricCheckRequestData
• BreastDetection
• BrokenRule
• Callback
• CheckResult
• CheckResultDetectionsInner
• Config
• Coordinates
• Data
• Detection
• DocumentCheckRequestData
• Encoded
• Event
• FaceDetection
• HairAttribute
• HairDetection
• IdDocumentAttribute
• IdDocumentDetection
• IdDocumentSubChecks
• ImageAnalysisDetection
• KnownFace
• KycUiParameter
• LanguageAttribute
• LicenseInfo
• LiveDocumentCheckRequestData
• LiveDocumentCheckResponseData
• Param
• ParamSet
• PoaCheckRequestData
• PoaDocumentAttribute
• PoaDocumentDetection
• PoaDocumentSubChecks
• Pricing
• Rectangle
• Segment
• Summary
• TextDetection
• ValueAttribute

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

info@irisnet.de