README.md

blockscore-ruby

This is the official library for Ruby clients of the BlockScore API. Click here to read the full documentation including code examples.

Install

Via rubygems.org:

gem install blockscore

If you are using Rails, add the following to your Gemfile:

gem 'blockscore', '~> 4.2.1'

Getting Started

To get started, you can initialize the library with one line:

BlockScore.api_key = 'your-api-key'

To verify a person:

person = BlockScore::Person.create(
  birth_day: '23',
  birth_month: '8',
  birth_year: '1980',
  document_type: 'ssn',
  document_value: '0000',
  name_first: 'John',
  name_middle: 'Pearce',
  name_last: 'Doe',
  address_street1: '1 Infinite Loop',
  address_street2: 'Apt 6',
  address_city: 'Cupertino',
  address_subdivision: 'CA',
  address_postal_code: '95014',
  address_country_code: 'US'
)

# Check the validation status of the Person
person.status
# => 'valid'

# Or view some of the other attributes
person.details.address
# => 'mismatch'

To see the list of calls you can make, please visit our full Ruby API reference.

Testing

In order to run the test suite:

$ rspec