Project

checkr-rb

0.01
Bugfix fork ofcheckr
No commit activity in last 3 years
No release in over 3 years
checkr-rbvijendra/checkrHomepageDocumentationSource CodeBug TrackerWiki
checkr.io API wrapper: Automated background screenings and driving records
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,965
Stars
7
Forks
7
Watchers
2
 Releases
Current version
0.0.3a
Total releases
1
First release
2015-04-06
Latest release
2015-04-06
 Issues
Open Issues
1
Closed Issues
3
Total Issues
4
Issue Closure Rate
75%
 Pull Requests
Open Pull Requests
3
Closed Pull Requests
1
Merged Pull Requests
2
Pull Request Acceptance Rate
33%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2014-11-04
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 1.7
codeclimate-test-reporter
>= 0
rake
~> 10.0
vcr
>= 0
webmock
>= 0

Runtime

httparty
>= 0
 Project Readme

Checkr

Ruby wrapper for checkr.io API (https://checkr.io/docs)

Installation

Add this line to your application's Gemfile:

gem 'checkr-rb'

And then execute:

$ bundle

Or install it yourself as:

$ gem install checkr-rb

Usage

Configure authentication keys

Checkr.configure do |c|
  c.api_key   = "83ebeabdec09f6670863766f792ead24d61fe3f9" #Test token from checkr api document
end

Create subaccount

subaccount = Checkr::Subaccount.create(:name => 'Checkr', :entity_name => 'My Company', :tax_id => 'XXXXX', :representative_title => 'CEO', :representative_name => 'John Smith', :representative_email => 'john.smith@company.org', :phone => '3101111111',
:incorporation_date => '2010-02-02', :incorporation_type => 'llc', :incorporation_state => 'DE', 'address[street]' => '3230 3rd street', 'address[city]' => 'San Francisco',
'address[state]' => 'CA', 'address[zipcode]'=> '94110')

#Subaccount attributes
subaccount_id = subaccount.id

Create candidate for subaccount

candidate = Checkr::Candidate.create(:subaccount_id => '8168372aac5a952b90eb9acb', :first_name => 'John', :last_name => 'Smith', :dob => '1970-01-22', :ssn => '111-11-2000', :phone => '5555555555', :email => 'john@smith.org')

#candidate attributes
candidate_id = candidate.id

Create candidate

candidate = Checkr::Candidate.create(:first_name => 'John', :last_name => 'Smith', :dob => '1970-01-22', :ssn => '111-11-2000', :phone => '5555555555', :email => 'john@smith.org')

#candidate attributes
candidate_id = candidate.id

Find candidate

candidate = Checkr::Candidate.find('e44aa283528e6fde7d542194')
candidate.id #Returns checkr id of the candidate
candidate.first_name #Returns first_name of the candidate

Get all reports belongs to candidate, if exists

candidate = Checkr::Subaccount.find('e44aa283528e6fde7d542194')
candidate.reports #Returns array of Checkr::Report objects

Create report

report = Checkr::Report.create(:package => 'driver_plus', :candidate_id => 'e44aa283528e6fde7d542194')
report.id #Returns the checkr id of the created report

Find report

report = Checkr::Report.find("5878551b3ee1eacae5a2c558")
report.id #Returns the checkr id of the created report
report.status #Returns the status of the report

Find individual reports

report = Checkr::MotorVehicleReport.find("5878551b3ee1eacae5a2c558")
report = Checkr::CountryCriminalSearch.find("5878551b3ee1eacae5a2c558")
report = Checkr::NationalCriminalSearch.find("5878551b3ee1eacae5a2c558")
report = Checkr::SexOffenderSearch.find("5878551b3ee1eacae5a2c558")
report = Checkr::SsnTrace.find("5878551b3ee1eacae5a2c558")
report = Checkr::TerroristWatchlistSearch.find("5878551b3ee1eacae5a2c558")

report.status #Returns the status of the report
report.records #Returns array of ReportRecord objects, if report has records
report.records.first.charges #Returns array of ReportCharge objects, if report has charges
report.accidents #In case of motor vehicle report
report.voilations #In case of motor vehicle report

Contributing

  1. Fork it ( https://github.com/[my-github-username]/checkr/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