Onfido\DefaultApi

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

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

`cancelReport()`

cancelReport($report_id)

This endpoint is for cancelling individual paused reports.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$report_id = 'report_id_example'; // string

try {
    $apiInstance->cancelReport($report_id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->cancelReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
report_id	string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createApplicant()`

createApplicant($applicant_request): \Onfido\Model\ApplicantResponse

Create Applicant

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_request = new \Onfido\Model\ApplicantRequest(); // \Onfido\Model\ApplicantRequest

try {
    $result = $apiInstance->createApplicant($applicant_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createApplicant: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_request	\Onfido\Model\ApplicantRequest

Return type

\Onfido\Model\ApplicantResponse

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createCheck()`

createCheck($check_request): \Onfido\Model\CheckResponse

Create a check

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$check_request = new \Onfido\Model\CheckRequest(); // \Onfido\Model\CheckRequest

try {
    $result = $apiInstance->createCheck($check_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createCheck: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_request	\Onfido\Model\CheckRequest

Return type

\Onfido\Model\CheckResponse

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createWebhook()`

createWebhook($webhook_request): \Onfido\Model\WebhookResponse

Create a webhook

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$webhook_request = new \Onfido\Model\WebhookRequest(); // \Onfido\Model\WebhookRequest

try {
    $result = $apiInstance->createWebhook($webhook_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->createWebhook: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webhook_request	\Onfido\Model\WebhookRequest

Return type

\Onfido\Model\WebhookResponse

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteWebhook()`

deleteWebhook($webhook_id)

Delete a webhook

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$webhook_id = 'webhook_id_example'; // string

try {
    $apiInstance->deleteWebhook($webhook_id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->deleteWebhook: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webhook_id	string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`destroyApplicant()`

destroyApplicant($applicant_id)

Delete Applicant

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string

try {
    $apiInstance->destroyApplicant($applicant_id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->destroyApplicant: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`downloadDocument()`

downloadDocument($document_id): \SplFileObject

Download a documents raw data

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$document_id = 'document_id_example'; // string

try {
    $result = $apiInstance->downloadDocument($document_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->downloadDocument: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
document_id	string

Return type

\SplFileObject

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: */*, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`downloadLivePhoto()`

downloadLivePhoto($live_photo_id): \SplFileObject

Download live photo

Live photos are downloaded using this endpoint.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$live_photo_id = 'live_photo_id_example'; // string | The live photo’s unique identifier.

try {
    $result = $apiInstance->downloadLivePhoto($live_photo_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->downloadLivePhoto: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
live_photo_id	string	The live photo’s unique identifier.

Return type

\SplFileObject

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: */*, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`downloadLiveVideo()`

downloadLiveVideo($live_video_id): \SplFileObject

Download live video

Live videos are downloaded using this endpoint.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$live_video_id = 'live_video_id_example'; // string | The live video’s unique identifier.

try {
    $result = $apiInstance->downloadLiveVideo($live_video_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->downloadLiveVideo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
live_video_id	string	The live video’s unique identifier.

Return type

\SplFileObject

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: */*, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`editWebhook()`

editWebhook($webhook_id, $webhook_request): \Onfido\Model\WebhookResponse

Edit a webhook

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$webhook_id = 'webhook_id_example'; // string
$webhook_request = new \Onfido\Model\WebhookRequest(); // \Onfido\Model\WebhookRequest

try {
    $result = $apiInstance->editWebhook($webhook_id, $webhook_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->editWebhook: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webhook_id	string
webhook_request	\Onfido\Model\WebhookRequest

Return type

\Onfido\Model\WebhookResponse

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findAddresses()`

findAddresses($postcode): \Onfido\Model\AddressesList

Search for addresses by postcode

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$postcode = 'postcode_example'; // string

try {
    $result = $apiInstance->findAddresses($postcode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findAddresses: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
postcode	string

Return type

\Onfido\Model\AddressesList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findApplicant()`

findApplicant($applicant_id): \Onfido\Model\ApplicantResponse

Retrieve Applicant

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string

try {
    $result = $apiInstance->findApplicant($applicant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findApplicant: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string

Return type

\Onfido\Model\ApplicantResponse

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findCheck()`

findCheck($check_id): \Onfido\Model\CheckResponse

Retrieve a Check

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$check_id = 'check_id_example'; // string

try {
    $result = $apiInstance->findCheck($check_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findCheck: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_id	string

Return type

\Onfido\Model\CheckResponse

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findDocument()`

findDocument($document_id): \Onfido\Model\DocumentResponse

A single document can be retrieved by calling this endpoint with the document’s unique identifier.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$document_id = 'document_id_example'; // string

try {
    $result = $apiInstance->findDocument($document_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findDocument: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
document_id	string

Return type

\Onfido\Model\DocumentResponse

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findLivePhoto()`

findLivePhoto($live_photo_id): \Onfido\Model\LivePhotoResponse

Retrieve live photo

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$live_photo_id = 'live_photo_id_example'; // string | The live photo’s unique identifier.

try {
    $result = $apiInstance->findLivePhoto($live_photo_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findLivePhoto: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
live_photo_id	string	The live photo’s unique identifier.

Return type

\Onfido\Model\LivePhotoResponse

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findLiveVideo()`

findLiveVideo($live_video_id): \Onfido\Model\LiveVideo

Retrieve live video

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$live_video_id = 'live_video_id_example'; // string | The live video’s unique identifier.

try {
    $result = $apiInstance->findLiveVideo($live_video_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findLiveVideo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
live_video_id	string	The live video’s unique identifier.

Return type

\Onfido\Model\LiveVideo

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findReport()`

findReport($report_id): \Onfido\Model\Report

A single report can be retrieved using this endpoint with the corresponding unique identifier.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$report_id = 'report_id_example'; // string

try {
    $result = $apiInstance->findReport($report_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
report_id	string

Return type

\Onfido\Model\Report

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`findWebhook()`

findWebhook($webhook_id): \Onfido\Model\WebhookResponse

Retrieve a Webhook

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$webhook_id = 'webhook_id_example'; // string

try {
    $result = $apiInstance->findWebhook($webhook_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->findWebhook: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
webhook_id	string

Return type

\Onfido\Model\WebhookResponse

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`frameLiveVideo()`

frameLiveVideo($live_video_id): \SplFileObject

Download live video frame

Instead of the whole video, a single frame can be downloaded using this endpoint. Returns the binary data representing the frame.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$live_video_id = 'live_video_id_example'; // string | The live video’s unique identifier.

try {
    $result = $apiInstance->frameLiveVideo($live_video_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->frameLiveVideo: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
live_video_id	string	The live video’s unique identifier.

Return type

\SplFileObject

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: */*, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`generateSdkToken()`

generateSdkToken($sdk_token_request): \Onfido\Model\SdkTokenResponse

Generate a SDK token

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$sdk_token_request = new \Onfido\Model\SdkTokenRequest(); // \Onfido\Model\SdkTokenRequest

try {
    $result = $apiInstance->generateSdkToken($sdk_token_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->generateSdkToken: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sdk_token_request	\Onfido\Model\SdkTokenRequest

Return type

\Onfido\Model\SdkTokenResponse

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listApplicants()`

listApplicants($page, $per_page, $include_deleted): \Onfido\Model\ApplicantsList

List Applicants

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$page = 1; // int | The page to return. The first page is `page=1`
$per_page = 20; // int | The number of objects per page.
$include_deleted = false; // bool | Whether to also include applicants scheduled for deletion.

try {
    $result = $apiInstance->listApplicants($page, $per_page, $include_deleted);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->listApplicants: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
page	int	The page to return. The first page is `page=1`	[optional] [default to 1]
per_page	int	The number of objects per page.	[optional] [default to 20]
include_deleted	bool	Whether to also include applicants scheduled for deletion.	[optional] [default to false]

Return type

\Onfido\Model\ApplicantsList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listChecks()`

listChecks($applicant_id): \Onfido\Model\ChecksList

Retrieve Checks

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string

try {
    $result = $apiInstance->listChecks($applicant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->listChecks: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string

Return type

\Onfido\Model\ChecksList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listDocuments()`

listDocuments($applicant_id): \Onfido\Model\DocumentsList

List documents

All documents belonging to an applicant can be listed from this endpoint

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string

try {
    $result = $apiInstance->listDocuments($applicant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->listDocuments: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string

Return type

\Onfido\Model\DocumentsList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listLivePhotos()`

listLivePhotos($applicant_id): \Onfido\Model\LivePhotosList

List live photos

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string | The id of the applicant the live photos belong to.

try {
    $result = $apiInstance->listLivePhotos($applicant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->listLivePhotos: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string	The id of the applicant the live photos belong to.

Return type

\Onfido\Model\LivePhotosList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listLiveVideos()`

listLiveVideos($applicant_id): \Onfido\Model\LiveVideosList

List live videos

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string | The id of the applicant the live videos belong to.

try {
    $result = $apiInstance->listLiveVideos($applicant_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->listLiveVideos: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string	The id of the applicant the live videos belong to.

Return type

\Onfido\Model\LiveVideosList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listReports()`

listReports($check_id): \Onfido\Model\ReportsList

All the reports belonging to a particular check can be listed from this endpoint.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$check_id = 'check_id_example'; // string

try {
    $result = $apiInstance->listReports($check_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->listReports: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_id	string

Return type

\Onfido\Model\ReportsList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listWebhooks()`

listWebhooks(): \Onfido\Model\WebhooksList

List webhooks

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Onfido\Model\WebhooksList

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`restoreApplicant()`

restoreApplicant($applicant_id)

Restore Applicant

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string

try {
    $apiInstance->restoreApplicant($applicant_id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->restoreApplicant: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`resumeCheck()`

resumeCheck($check_id)

Resume a Check

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$check_id = 'check_id_example'; // string

try {
    $apiInstance->resumeCheck($check_id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->resumeCheck: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
check_id	string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`resumeReport()`

resumeReport($report_id)

This endpoint is for resuming individual paused reports.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$report_id = 'report_id_example'; // string

try {
    $apiInstance->resumeReport($report_id);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->resumeReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
report_id	string

Return type

void (empty response body)

Authorization

Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateApplicant()`

updateApplicant($applicant_id, $applicant_request): \Onfido\Model\ApplicantResponse

Update Applicant

Allows updating of an applicant’s information before any checks are created. - Partial updates - Addresses and ID numbers present will replace existing ones - Same applicant validations to create applicant

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string
$applicant_request = new \Onfido\Model\ApplicantRequest(); // \Onfido\Model\ApplicantRequest

try {
    $result = $apiInstance->updateApplicant($applicant_id, $applicant_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->updateApplicant: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string
applicant_request	\Onfido\Model\ApplicantRequest

Return type

\Onfido\Model\ApplicantResponse

Authorization

Token

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`uploadDocument()`

uploadDocument($applicant_id, $type, $file, $side, $issuing_country, $validate_image_quality, $location): \Onfido\Model\DocumentResponse

Upload a document

Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string | The ID of the applicant whose document is being uploaded.
$type = 'type_example'; // string | The type of document.
$file = "/path/to/file.txt"; // \SplFileObject | The file to be uploaded.
$side = 'side_example'; // string | Either the `front` or `back` of the document.
$issuing_country = 'issuing_country_example'; // string | The issuing country of the document, a 3-letter ISO code.
$validate_image_quality = True; // bool | Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.
$location = new \Onfido\Model\Location(); // \Onfido\Model\Location

try {
    $result = $apiInstance->uploadDocument($applicant_id, $type, $file, $side, $issuing_country, $validate_image_quality, $location);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->uploadDocument: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string	The ID of the applicant whose document is being uploaded.
type	string	The type of document.
file	\SplFileObject\SplFileObject	The file to be uploaded.
side	string	Either the `front` or `back` of the document.	[optional]
issuing_country	string	The issuing country of the document, a 3-letter ISO code.	[optional]
validate_image_quality	bool	Defaults to false. When true the submitted image will undergo an image quality validation which may take up to 5 seconds.	[optional]
location	\Onfido\Model\Location		[optional]

Return type

\Onfido\Model\DocumentResponse

Authorization

Token

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`uploadLivePhoto()`

uploadLivePhoto($applicant_id, $file, $advanced_validation): \Onfido\Model\LivePhotoResponse

Upload live photo

You can upload live photos to this endpoint. Like document upload, files must be uploaded as a multipart form. Valid file types are jpg, png and pdf. The file size must be between 32KB and 10MB. Live photos are validated at the point of upload to check that they contain exactly one face. This validation can be disabled by setting the advanced_validation argument to false.

Example

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

$config = Onfido\Configuration::getDefaultConfiguration();
$config->setApiKey('Authorization', 'token=' . 'YOUR API KEY');
$config->setApiKeyPrefix('Authorization', 'Token');

$apiInstance = new Onfido\Api\DefaultApi(
    // 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
);
$applicant_id = 'applicant_id_example'; // string
$file = "/path/to/file.txt"; // \SplFileObject | The file to be uploaded.
$advanced_validation = true; // bool | Validates that the live photo contains exactly one face.

try {
    $result = $apiInstance->uploadLivePhoto($applicant_id, $file, $advanced_validation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->uploadLivePhoto: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
applicant_id	string
file	\SplFileObject\SplFileObject	The file to be uploaded.
advanced_validation	bool	Validates that the live photo contains exactly one face.	[optional] [default to true]

Return type

\Onfido\Model\LivePhotoResponse

Authorization

Token

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

DefaultApi.md

Latest commit

History

DefaultApi.md

File metadata and controls

Onfido\DefaultApi

cancelReport()

Example

Parameters

Return type

Authorization

HTTP request headers

createApplicant()

Example

Parameters

Return type

Authorization

HTTP request headers

createCheck()

Example

Parameters

Return type

Authorization

HTTP request headers

createWebhook()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteWebhook()

Example

Parameters

Return type

Authorization

HTTP request headers

destroyApplicant()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadLivePhoto()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadLiveVideo()

Example

Parameters

Return type

Authorization

HTTP request headers

editWebhook()

Example

Parameters

Return type

Authorization

HTTP request headers

findAddresses()

Example

Parameters

Return type

Authorization

HTTP request headers

findApplicant()

Example

Parameters

Return type

Authorization

HTTP request headers

findCheck()

`cancelReport()`

`createApplicant()`

`createCheck()`

`createWebhook()`

`deleteWebhook()`

`destroyApplicant()`

`downloadDocument()`

`downloadLivePhoto()`

`downloadLiveVideo()`

`editWebhook()`

`findAddresses()`

`findApplicant()`

`findCheck()`

`findDocument()`

`findLivePhoto()`

`findLiveVideo()`

`findReport()`

`findWebhook()`

`frameLiveVideo()`

`generateSdkToken()`

`listApplicants()`

`listChecks()`

`listDocuments()`