Skip to content

Latest commit

 

History

History
130 lines (93 loc) · 4.15 KB

README.md

File metadata and controls

130 lines (93 loc) · 4.15 KB
Raw

idcheckio-php-client

Check identity documents

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/ariadnext/php-IDCHECKIO.git"
    }
  ],
  "require": {
    "ariadnext/php-IDCHECKIO": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/idcheckio-php-client/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

$api_instance = new idcheckio\Api\AdministrationApi();

try {
    $result = $api_instance->getHealth();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdministrationApi->getHealth: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://localhost/rest

Class Method HTTP request Description
AdministrationApi getHealth GET /v0/admin/health HTTP GET health
AdministrationApi getUser GET /v0/admin/user HTTP GET user
AnalysisApi getReport GET /v0/pdfreport/{analysisRefUid} HTTP GET report (demo)
AnalysisApi getResult GET /v0/result/{analysisRefUid} HTTP GET result
AnalysisApi getTask GET /v0/task/{analysisRefUid} HTTP GET task
AnalysisApi postImage POST /v0/task/image HTTP POST task image
AnalysisApi postMrz POST /v0/task/mrz HTTP POST task mrz
SandboxApi getImage GET /v0/sandbox/image/{imageUid} HTTP GET image
SandboxApi getImageList GET /v0/sandbox/imagelist HTTP GET images list
SandboxApi getMrz GET /v0/sandbox/mrz/{mrzUid} HTTP GET mrz
SandboxApi getMrzList GET /v0/sandbox/mrzlist HTTP GET mrz list

Documentation For Models

Documentation For Authorization

basic

  • Type: HTTP basic authentication

Author