README.md in onfido-0.13.0 vs README.md in onfido-0.14.0
- old
+ new
@@ -10,29 +10,39 @@
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'onfido', '~> 0.12.0'
+gem 'onfido', '~> 0.13.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
-There are 5 configuration options:
+There are 6 configuration options:
```ruby
Onfido.configure do |config|
config.api_key = 'MY_API_KEY'
config.api_version = 'v2'
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:
```ruby
@@ -56,13 +66,17 @@
Applicants are the object upon which Onfido checks are performed.
```ruby
api.applicant.create(params) # => Creates an applicant
api.applicant.update('applicant_id', params) # => Updates an applicant
-api.applicant.destroy('applicant_id') # => Destroy 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 be restored.
+See https://documentation.onfido.com/#delete-applicant for more information.
#### Documents
Documents provide supporting evidence for Onfido checks.