Skip to content
A wrapper for Onfido's API
Ruby
Branch: master
Clone or download
Latest commit b6d2025 Jan 14, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib Version 1.0.0 Jan 13, 2020
spec update webhook spec fixtures to reflect correct event names Oct 30, 2019
.gitignore Move resources to a separate folder May 12, 2016
.rspec Less verbose rspec format Nov 11, 2015
.rubocop.yml fix linting error and update rubocop config Jan 28, 2019
.travis.yml remove allowed failure versions Jan 28, 2019
CHANGELOG.md Update CHANGELOG.md Jan 14, 2020
Gemfile
LICENSE update licence and authors Oct 30, 2019
README.md Update README.md Jan 13, 2020
Rakefile Add rubocop Nov 11, 2015
onfido.gemspec update licence and authors Oct 30, 2019

README.md

Onfido

A thin wrapper for Onfido's API.

Gem Version Build Status

This gem supports only v3 of Onfido's API from version 1.0.0 ownards. The latest version that supports v2 of Onfido's API is 0.15.0. v1 of Onfido's API is deprecated.

Refer to Onfido's API documentation for details of the expected requests and responses.

Installation

Add this line to your application's Gemfile:

gem 'onfido', '~> 1.0.0'

The gem is compatible with Ruby 2.2.0 and onwards. Earlier versions of Ruby have reached end-of-life, are no longer supported and no longer receive security fixes.

Configuration

There are 5 configuration options:

Onfido.configure do |config|
  config.api_key = 'MY_API_KEY'
  config.logger = Logger.new(STDOUT)
  config.open_timeout = 30
  config.read_timeout = 80
  config.region = nil
end

Regions

The gem will use the default region if no region is specified.

To specify the US region do: config.region = :us

See https://documentation.onfido.com/#regions for supported regions.

Usage

You can make API calls by using an instance of the API class:

api = Onfido::API.new

Alternatively, you can set an API key here instead of in the initializer:

api = Onfido::API.new(api_key: 'API_KEY')

Resources

All resources share the same interface when making API calls. Use .create to create a resource, .find to find one, and .all to fetch all resources.

Note: All param keys should be a symbol e.g. { report_names: ['document'] }

Applicants

Applicants are the object upon which Onfido checks are performed.

api.applicant.create(params)                  # => Creates an applicant
api.applicant.update('applicant_id', params)  # => Updates an applicant
api.applicant.destroy('applicant_id')         # => Schedule an applicant for deletion
api.applicant.restore('applicant_id')         # => Restore an applicant scheduled for deletion
api.applicant.find('applicant_id')            # => Finds a single applicant
api.applicant.all                             # => Returns all applicants

Note: Calling api.applicant.destroy adds the applicant and all associated documents, photos, videos, checks, and reports to the deletion queue. They will be deleted 20 days after the request is made. An applicant that is scheduled for deletion can be restored but applicants that have been permanently deleted cannot. See https://documentation.onfido.com/#delete-applicant for more information.

Documents

Documents provide supporting evidence for Onfido checks.

api.document.create('applicant_id', file: 'http://example.com', type: 'passport') # => Creates a document
api.document.find('document_id') # => Finds a document
api.document.download('document_id') # => Downloads a document as a binary data
api.document.all('applicant_id') # => Returns all applicant's documents

Note: The file parameter must be a File-like object which responds to #read and #path. Previous versions of this gem supported providing a URL to a file accessible over HTTP or a path to a file in the local filesystem. You should instead load the file yourself and then pass it in to #create.

Live Photos

Live Photos, like documents, can provide supporting evidence for Onfido checks.

api.live_photo.create('applicant_id', file: 'http://example.com')
api.live_photo.find(live_photo_id) # => Finds a live photo
api.live_photo.download(live_photo_id) # => Downloads a live photo as binary data
api.live_photo.all(applicant_id) # => Returns all applicant's live photos

Note: The file parameter must be a File-like object which responds to #read and #path. Previous versions of this gem supported providing a URL to a file accessible over HTTP or a path to a file in the local filesystem. You should instead load the file yourself and then pass it in to #create.

Checks

Checks are requests for Onfido to check an applicant, by commissioning one or more "reports" on them.

api.check.create('applicant_id', report_names: ['document'])
api.check.find('check_id')
api.check.resume('check_id')
api.check.all('applicant_id')

Reports

Reports provide details of the results of some part of a "check". They are created when a check is created, so the Onfido API only provides support for finding and listing them. For paused reports specifically, additional support for resuming and cancelling reports is also available.

api.report.find('report_id')
api.report.all('check_id')
api.report.resume('report_id')
api.report.cancel('report_id')

Address Lookups

Onfido provides an address lookup service, to help ensure well-formatted addresses are provided when creating "applicants". To search for addresses by postcode, use:

api.address.all('SE1 4NG')

Webhook Endpoints

Onfido allows you to set up and view your webhook endpoints via the API, as well as through the dashboard.

api.webhook.create(params)          # => Creates a webhook endpoint
api.webhook.find('webhook_id')      # => Finds a single webhook endpoint
api.webhook.all                     # => Returns all webhook endpoints

SDK Tokens

Onfido allows you to generate JSON Web Tokens via the API in order to authenticate with Onfido's JavaScript SDK.

api.sdk_token.create(applicant_id: 'applicant_id', referrer: 'referrer')

Error Handling

There are three classes of errors raised by the library, all of which subclass Onfido::OnfidoError:

  • Onfido::ServerError is raised whenever Onfido returns a 5xx response
  • Onfido::RequestError is raised whenever Onfido returns any other kind of error
  • Onfido::ConnectionError is raised whenever a network error occurs (e.g., a timeout)

All three error classes provide the response_code, response_body, json_body, type and fields of the error (although for Onfido::ServerError and Onfido::ConnectionError the last three are likely to be nil).

def create_applicant
  api.applicant.create(params)
rescue Onfido::RequestError => e
  e.type          # => 'validation_error'
  e.fields        # => { "email": { "messages": ["invalid format"] } }
  e.response_code # => '422'
end

Webhooks

Each webhook endpoint has a secret token, generated automatically and exposed in the API. When sending a request, Onfido includes a signature computed using the request body and this token in the X-Signature header.

This provided signature should be compared to one you generate yourself with the token to check that a webhook is a genuine request from Onfido.

if Onfido::Webhook.valid?(request.raw_post,
                          request.headers["X-Signature"],
                          ENV['ONFIDO_WEBHOOK_TOKEN'])
  process_webhook
else
  render status: 498, text: "498 Token expired/invalid"
end

Roadmap

  • Improve test coverage with more scenarios
  • Add custom errors based on the response code
  • Improve pagination handling (use information passed in link header)

Contributing

  1. Fork it ( https://github.com/onfido/onfido/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request
You can’t perform that action at this time.