Download the PHP package onfido/api-php-client without Composer

On this page you can find all versions of the php package onfido/api-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package api-php-client

onfido-php

The Onfido API is used to submit check requests.

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

Requirements

PHP 7.3 and later

Installation & Usage

Composer

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

Tests

To run the unit tests:

Getting Started

Please follow the installation procedure and then run the following:

Documentation for API Endpoints

All URIs are relative to https://api.eu.onfido.com/v3.6

Class Method HTTP request Description
DefaultApi cancelReport POST /reports/{report_id}/cancel This endpoint is for cancelling individual paused reports.
DefaultApi createApplicant POST /applicants Create Applicant
DefaultApi createCheck POST /checks Create a check
DefaultApi createWebhook POST /webhooks Create a webhook
DefaultApi deleteWebhook DELETE /webhooks/{webhook_id} Delete a webhook
DefaultApi destroyApplicant DELETE /applicants/{applicant_id} Delete Applicant
DefaultApi downloadCheck GET /checks/{check_id}/download Download a check raw data
DefaultApi downloadDocument GET /documents/{document_id}/download Download a documents raw data
DefaultApi downloadLivePhoto GET /live_photos/{live_photo_id}/download Download live photo
DefaultApi downloadLiveVideo GET /live_videos/{live_video_id}/download Download live video
DefaultApi downloadMotionCapture GET /motion_captures/{motion_capture_id}/download Download motion capture
DefaultApi downloadSignedEvidenceFile GET /workflow_runs/{workflow_run_id}/signed_evidence_file Retrieves the signed evidence file for the designated Workflow Run
DefaultApi editWebhook PUT /webhooks/{webhook_id} Edit a webhook
DefaultApi findAddresses GET /addresses/pick Search for addresses by postcode
DefaultApi findApplicant GET /applicants/{applicant_id} Retrieve Applicant
DefaultApi findCheck GET /checks/{check_id} Retrieve a Check
DefaultApi findDocument GET /documents/{document_id} A single document can be retrieved by calling this endpoint with the document’s unique identifier.
DefaultApi findLivePhoto GET /live_photos/{live_photo_id} Retrieve live photo
DefaultApi findLiveVideo GET /live_videos/{live_video_id} Retrieve live video
DefaultApi findMotionCapture GET /motion_captures/{motion_capture_id} Retrieve motion capture
DefaultApi findReport GET /reports/{report_id} A single report can be retrieved using this endpoint with the corresponding unique identifier.
DefaultApi findWebhook GET /webhooks/{webhook_id} Retrieve a Webhook
DefaultApi frameLiveVideo GET /live_videos/{live_video_id}/frame Download live video frame
DefaultApi frameMotionCapture GET /motion_captures/{motion_capture_id}/frame Download motion capture frame
DefaultApi generateSdkToken POST /sdk_token Generate a SDK token
DefaultApi listApplicants GET /applicants List Applicants
DefaultApi listChecks GET /checks Retrieve Checks
DefaultApi listDocuments GET /documents List documents
DefaultApi listLivePhotos GET /live_photos List live photos
DefaultApi listLiveVideos GET /live_videos List live videos
DefaultApi listMotionCaptures GET /motion_captures List motion captures
DefaultApi listReports GET /reports All the reports belonging to a particular check can be listed from this endpoint.
DefaultApi listWebhooks GET /webhooks List webhooks
DefaultApi restoreApplicant POST /applicants/{applicant_id}/restore Restore Applicant
DefaultApi resumeCheck POST /checks/{check_id}/resume Resume a Check
DefaultApi resumeReport POST /reports/{report_id}/resume This endpoint is for resuming individual paused reports.
DefaultApi updateApplicant PUT /applicants/{applicant_id} Update Applicant
DefaultApi uploadDocument POST /documents Upload a document
DefaultApi uploadLivePhoto POST /live_photos Upload live photo

Documentation For Models

Documentation For Authorization

Token

Support

Should you encounter any technical issues during integration, please contact Onfido’s Customer Support team via email, including the word ISSUE: at the start of the subject line.

Alternatively, you can search the support documentation available via the customer experience portal, public.support.onfido.com.


All versions of api-php-client with dependencies

PHP Build Version
Package Version
Requires php Version ^7.3 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package onfido/api-php-client contains the following files

Loading the files please wait ....