Git Product home page Git Product logo

blockscore-ruby's Introduction

blockscore-ruby

License Circle CI Code Climate Test Coverage Dependency Status

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

blockscore-ruby's People

Contributors

alainmeier avatar backus avatar bmschwartz avatar connorjacobsen avatar dkubb avatar eugeneotto avatar kapilkale avatar ofthedelmer avatar sirwolfgang avatar thedavemarshall avatar tjchambers avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.