Equifax Ruby provides ruby bindings to the Equifax VOE/VOI services
Add this line to your application's Gemfile:
gem 'equifax-ruby'
And then execute:
$ bundle
Or install it yourself as:
$ gem install equifax-ruby
VIA Initializer
Set Equifax Credentials in your applications initializer
Equifax::Client.account_number = '123456'
Equifax::Client.password = '123456'
VIA environment variable
Set Equifax Credentials via environment variables
export EQUIFAX_ACCOUNT_NUMBER="123456"
export EQUIFAX_PASSWORD="123456"
VIA request opts
hash
opts = { account_number: "123456", password: "password" }
response = Equifax::Worknumber::VOE::Instant.call(opts)
# url, vendor_id, first_name, last_name, ssn, street_address, city, state, postal_code
# either employer_code or employer_name are optional
# middle_name, employer_address, employer_city, employer_state, employer_postal_code are optional
opts = {
vendor_id: 'VENDORID',
first_name: 'Example',
last_name: 'Example',
ssn: '123456789',
street_address: '1234 Main St.',
city: 'Denver',
state: 'CO',
postal_code: '90206',
lender_case_id: 'LOANFILE123456',
employer_name: 'Chiptole'
}
response = Equifax::Worknumber::VOE::Instant.call(opts)
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https:/[USERNAME]/equifax-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.