Skip to content

Ruby wrapper for the Experian net connect API

License

Notifications You must be signed in to change notification settings

sittercity/experian

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Experian Precise Id Ruby Gem

Gem Version Build Status Code Climate

Experian exposes nearly 30 different services. This gem currently only implements the Precise Id product (identity validation).

Net Connect is a business-to-business application gateway designed to allow access to Experian legacy systems via the public Internet or Experian’s private TCP/IP extranet transport. It is a secure 168-bit encrypted transaction, using HTTPS. Net Connect is a non-browser-based system requiring Experian certified client or vendor software at the user's location. It utilizes XML for the input inquiry and has the capability of returning field-level XML, as well as our standard Automated Response Format (ARF) (computer readable), Teletype Response Format (TTY) (human readable) and Parallel Profile (both ARF and TTY in one response). Net Connect meets the encryption standards requirement in the Safeguards section of the Gramm- Leach-Bliley (GLB) Act.

Net Connect Products

  • Address Update
  • Authentication Services
  • BizID
  • Bullseye
  • Checkpoint - File One Verification Solution
  • Collection Advantage interactive
  • Collection Report
  • Connect Check
  • Credit Profile
  • Custom Solution
  • Cross View
  • CU Decision Expert
  • Custom Strategist
  • Decode
  • Demographics
  • Direct Check
  • Employment Insight
  • Fraud Shield
  • Instant Prescreen
  • New Consumer Identification
  • Numeric Inquiry
  • Parallel Profile
  • Profile Summary
  • Precise ID
  • Precise ID Distributed
  • Risk Models
  • Social Search
  • Truvue

Installation

Add this line to your application's Gemfile:

gem 'experian'

And then execute:

$ bundle

Or install it yourself as:

$ gem install experian

Usage

Configuration

Experian will provide you with the following authentication credentials when you sign up for their service:

# Provide authentication credentials
Experian.configure do |config|
  config.preamble = "FCD2"
  config.op_initials = "AB"
  config.subcode = "1968543"
  config.user = "user"
  config.password = "password"
  config.vendor_number = "P55"
end

# Route requests to Experian test server instead of production
Experian.test_mode = true

Using a product client

Products are namespaced under the Experian module. Example of how to create a client for the Connect Check product:

client = ::Experian::PreciseId::Client.new

Once you have a client, you can make requests:

response = client.check_id({
  first_name: "Homer",
  last_name: "Simpson",
  street: "742 Evergreen Terrace",
  city: "Springfield",
  state: "IL",
  zip: "00000",
  phone: "1234567890",
  dob: "01011972",
  email: "[email protected]",
  ip_address: "127.0.0.1"
})

response.success?
# => true
response.initial_decision
# => "ACC"

Handling errors from Experian

response = client.check_id(first_name: "Homer", last_name: "Simpson")

response.success?
# => false
response.error_code
# => "0001"
response.error_message
# => "Invalid request format"

Examine raw request and response XML

If you need to troubleshoot by viewing the raw XML, it is accesssible on the request and response objects of the client:

# Inspect the request XML that was sent to Experian
request.xml
# => "<?xml version='1.0' encoding='utf-8'?>..."

# Inspect the response XML that was received from Experian
response.xml
# => "<?xml version='1.0' encoding='utf-8'?>..."

Contributing

  1. Fork it
  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 new Pull Request

Copyright

Copyright (c) 2012-2013 Eric Hutzelman. See LICENSE for details.

About

Ruby wrapper for the Experian net connect API

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages

  • Ruby 100.0%