README

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.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/IrisnetPHPClient/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: LICENSE-KEY
$config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKey('LICENSE-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Irisnet\API\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('LICENSE-KEY', 'Bearer');


$apiInstance = new Irisnet\API\Client\Api\AICheckOperationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$configId = 'configId_example'; // string | The configuration id from the Basic Configuration operations.
$biometricCheckRequestData = {"callback":{"callbackUrl":"https://www.example.com/callback?ageestimation"},"selfieImage":"/9j/4AAQSkZJRgABAQEASABIAAD..."}; // \Irisnet\API\Client\Model\BiometricCheckRequestData | The BiometricCheckRequestData containing data needed for the age verification check.

try {
    $result = $apiInstance->ageVerification($configId, $biometricCheckRequestData);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AICheckOperationsApi->ageVerification: ', $e->getMessage(), PHP_EOL;
}

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 an proof of address check 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	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.

Models

Authorization

Authentication schemes defined for the API:

LICENSE-KEY

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

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

info@irisnet.de

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: v2
- Package version: 3.7.6
- Generator version: 7.14.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

rstmgsnvimax / irisnet-ai-php-api-client

Maintainers

Details