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.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: v2
- Package version: 4.1.6
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://shop.airisprotect.com
Python 3.9+
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import irisnet_clientInstall via Setuptools.
python setup.py install --user(or sudo python setup.py install to install the package for all users)
Then import the package:
import irisnet_clientExecute pytest to run the tests.
Please follow the installation procedure and then run the following:
import irisnet_client
from irisnet_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.irisnet.de
# See configuration.py for a list of all supported configuration parameters.
configuration = irisnet_client.Configuration(
host = "https://api.irisnet.de"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure API key authorization: LICENSE-KEY
configuration.api_key['LICENSE-KEY'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['LICENSE-KEY'] = 'Bearer'
# Enter a context with an instance of the API client
with irisnet_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = irisnet_client.AICheckOperationsApi(api_client)
config_id = 'config_id_example' # str | The configuration id from the Basic Configuration operations.
biometric_check_request_data = {"callback":{"callbackUrl":"https://www.example.com/callback?ageestimation"},"selfieImage":"/9j/4AAQSkZJRgABAQEASABIAAD..."} # BiometricCheckRequestData | The BiometricCheckRequestData containing data needed for the age verification check.
try:
# Perform an age verfication check for a given selfie with the AI.
api_response = api_instance.age_verification(config_id, biometric_check_request_data)
print("The response of AICheckOperationsApi->age_verification:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling AICheckOperationsApi->age_verification: %s\n" % e)All URIs are relative to https://api.irisnet.de
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AICheckOperationsApi | age_verification | POST /v2/age-verification/{configId} | Perform an age verfication check for a given selfie with the AI. |
| AICheckOperationsApi | check_id_document | POST /v2/check-id-document/{configId} | Check an id document with the AI. |
| AICheckOperationsApi | check_image | POST /v2/check-image/{configId} | Check an image with the AI. |
| AICheckOperationsApi | check_poa_document | POST /v2/check-poa-document/{configId} | Perform a proof of address check with the AI. |
| AICheckOperationsApi | check_stream | POST /v2/check-stream/{configId} | Check a stream with the AI. |
| AICheckOperationsApi | check_text | POST /v2/check-text/{configId} | Check a text with the AI. |
| AICheckOperationsApi | check_video | POST /v2/check-video/{configId} | Check a video with the AI. |
| AICheckOperationsApi | face_authentication | POST /v2/face-authentication/{configId} | Perform a face authentication for a given selfie with the AI. |
| AICheckOperationsApi | live_document_check | POST /v2/check-live-id-document/{configId} | Start a guided live id document check with the AI. |
| BalanceEndpointsApi | get_cost | GET /v2/cost/{configId} | Get the cost of the configuration for a single image. |
| BalanceEndpointsApi | get_license_info | GET /v2/info | Get information for the given license key. |
| BalanceEndpointsApi | get_video_cost | GET /v2/cost/{configId}/{frames} | Get the cost of the configuration for moving images. |
| BalanceEndpointsApi | get_video_cost1 | GET /v2/cost/{configId}/{fps}/{duration} | Get the cost of the configuration for moving images. |
| ConfigurationManagementApi | delete_config | DELETE /v2/config/{configId} | Delete an AI configuration. |
| ConfigurationManagementApi | get_all_configs | GET /v2/config | List all saved AI configurations. |
| ConfigurationManagementApi | get_config | GET /v2/config/{configId} | Get a specific AI configuration. |
| ConfigurationManagementApi | set_config | POST /v2/config | Create a new AI configuration. |
| DetailedConfigurationParametersApi | clear_parameters | DELETE /v2/config/parameters/{configId} | Delete the parameters of the AI configuration. |
| DetailedConfigurationParametersApi | get_parameters | GET /v2/config/parameters/{configId} | Get the parameters of the AI configuration. |
| DetailedConfigurationParametersApi | set_parameters | POST /v2/config/parameters/{configId} | Set parameters to the given AI configuration. |
- 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
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: LICENSE-KEY
- Location: HTTP header