BigId Background Check's Library for Ruby

• Ruby: Any version
• Bundler

• bigid-auth-ruby - BigID API authentication module

gem install bigid_bgcheck

# Add to the Gemfile
gem "bigid_bgcheck", "~> 0.3"

source "https://rubygems.pkg.github.com/quasar-flash" do
  gem "bigid_bgcheck", "0.3.1"
end

# Set the env variables
ENV["BIGID_USERNAME"] = "your_username"
ENV["BIGID_PASSWORD"] = "your_password"

Create the config/initializers/bigid.rb file and define:

# Set the env variables
Bigid.configure do |config|
  config.username = "your_username"
  config.password = "your_password"
end

require "bigid_bgcheck"

Bigid::Bgcheck::Request.new.call(
  document: "000.000.000-00",
  document_type: "CPF",
  group: "Default"
)

#<Bigid::Bgcheck::Result:0x0000560fef3c1068
  @approved=false,
  @ticket_id="00000000000000000",
  @code=-1100,
  @message="Not Approved",
  @score=0,
  @limit_score=0.0>

Please do not directly email any committers with questions or problems. A community is best served when discussions are held in public.

Searching the issues for your problem is also a good idea.

• Check out the latest master to make sure the feature hasn"t been implemented or the bug hasn't been fixed yet;
• Check out the issue tracker to make sure someone already hasn"t requested it and/or contributed it;
• Fork the project;
• Start a feature/bugfix branch;
• Commit and push until you are happy with your contribution;
• Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.;
• Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Please see LICENSE for licensing details.

Danilo Carolino, @danilogco / @Quasar-Flash