PHPackages                             favor/onfido - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. favor/onfido

AbandonedArchivedLibrary[API Development](/categories/api)

favor/onfido
============

A library to interact with the Onfido REST API

04.6k2PHP

Since Jan 19Pushed 8y ago2 watchersCompare

[ Source](https://github.com/favordelivery/onfido)[ Packagist](https://packagist.org/packages/favor/onfido)[ RSS](/packages/favor-onfido/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (1)Used By (0)

Onfido
======

[](#onfido)

[![Code Climate](https://camo.githubusercontent.com/7cf89bcf8b352f4537654d6a836efc38833345a164ac4dcc3eb7798ffe19d6a3/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6661766f7264656c69766572792f6f6e6669646f2f6261646765732f6770612e737667)](https://codeclimate.com/github/favordelivery/onfido)[![Test Coverage](https://camo.githubusercontent.com/377456a23da5c49367a0be357452930be7cc4d4beacbe640cd3e5fe24d547add/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f6661766f7264656c69766572792f6f6e6669646f2f6261646765732f636f7665726167652e737667)](https://codeclimate.com/github/favordelivery/onfido/coverage)[![Build Status](https://camo.githubusercontent.com/42910623949c203f20133a6ed790ee60c4bc784ef3589154acc8e8822155764e/68747470733a2f2f7472617669732d63692e6f72672f6661766f7264656c69766572792f6f6e6669646f2e737667)](https://travis-ci.org/favordelivery/onfido)

A Composer library for Onfido's REST API

Requirements
------------

[](#requirements)

PHP 5.5

Installation
------------

[](#installation)

1. Add to Composer file

```
{
    "require": {
        "favor/onfido": "dev-master"
    }
}
```

2. Install

```
composer install

```

Use
---

[](#use)

Almost all calls will go through the Onfido client to generate and update content.

```
$client = new Onfido\RestClient(ONFIDO_TOKEN);
```

### Applicants

[](#applicants)

Applicants are the subjects of checks and reports in Onfido.

#### Create

[](#create)

The only required fields when creating an applicant are `first_name` and `last_name`.

```
$params = array(
    'title' => 'Mr',
    'first_name' => 'Tester',
    'middle_name' => 'Test',
    'last_name' => 'McTesterson',
    'email' => 'test@mail.com',
    'gender' => 'male',
    'dob' => '1990-11-23',
    'telephone' => '123-456-7890',
    'mobile' => '987-654-3210',
    'country' => 'usa',
    'addresses' => array(
        array(
            'flat_number' => '13',
            'building_number' => '2411',
            'street' => 'Main Avenue',
            'sub_street' => null,
            'state' => 'TX',
            'town' => 'Austin',
            'postcode' => '78702',
            'country' => 'usa',
            'start_date' => '1999-02-28',
            'end_date' => null
        )
    ),
    'id_numbers' => array(
        array(
            'type' => 'ssn',
            'value' => '433-54-3937'
        )
    )
);

$applicant = $client->createApplicant($params);
```

#### Retrieve

[](#retrieve)

```
$applicant = $client->retrieveApplicant('1030303-123123-123123');
```

### Checks

[](#checks)

All checks require the existence of an applicant in the Onfido system.

#### Identity Check

[](#identity-check)

##### Create

[](#create-1)

Identity checks that are run on U.S. residents require the applicant record to have an e-mail address, date of birth, and a social security number.

```
$identity_report = $client->runIdentityCheck('1030303-123123-123123');
```

###  Health Score

25

—

LowBetter than 37% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity18

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/5ce01eb9821cb8c1e5f0cfa6169332355369c2017dcea259ecc8c54da4c7585e?d=identicon)[rubenrangel](/maintainers/rubenrangel)

---

Top Contributors

[![rubenrangel](https://avatars.githubusercontent.com/u/1885160?v=4)](https://github.com/rubenrangel "rubenrangel (4 commits)")[![danhanly](https://avatars.githubusercontent.com/u/1150741?v=4)](https://github.com/danhanly "danhanly (2 commits)")[![iansltx](https://avatars.githubusercontent.com/u/472804?v=4)](https://github.com/iansltx "iansltx (1 commits)")[![rossmckelvie](https://avatars.githubusercontent.com/u/1254976?v=4)](https://github.com/rossmckelvie "rossmckelvie (1 commits)")

### Embed Badge

![Health badge](/badges/favor-onfido/health.svg)

```
[![Health](https://phpackages.com/badges/favor-onfido/health.svg)](https://phpackages.com/packages/favor-onfido)
```

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[facebook/php-business-sdk

PHP SDK for Facebook Business

90821.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

74513.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

265103.1M454](/packages/google-gax)[google/common-protos

Google API Common Protos for PHP

173103.7M50](/packages/google-common-protos)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)