README.md in onfido-0.14.0 vs README.md in onfido-0.15.0
- old
+ new
@@ -10,11 +10,11 @@
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'onfido', '~> 0.13.0'
+gem 'onfido', '~> 0.15.0'
```
The gem is compatible with Ruby 2.2.0 and onwards. Earlier versions of Ruby have [reached end-of-life](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/), are no longer supported and no longer receive security fixes.
## Configuration
@@ -72,11 +72,11 @@
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 be restored.
+**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.
@@ -115,9 +115,10 @@
more "reports" on them.
```ruby
api.check.create('applicant_id', type: 'express', reports: [{ name: 'identity' }])
api.check.find('applicant_id', 'check_id')
+api.check.find_by_url(params[:payload][:object][:href])
api.check.resume('check_id')
api.check.all('applicant_id')
```
#### Reports