blockscore

Block Score API wrapper

npm install blockscore
6 downloads in the last month

blockscore-node

This is the official library for Node.JS clients of the BlockScore API. Click here to read the full documentation.

Install

Via npm:

npm install blockscore

Getting Started

Initializing BlockScore

var blockscore = require('blockscore')('your api key')

Verifications

List all verifications

blockscore.verifications.list({}, callback);

List 5 verifications

blockscore.verifications.list({
  count: 5
}, callback);

View a verification by ID

blockscore.verifications.retrieve(verification_id, callback);

Create a new verification

blockscore.verifications.create({
    type: "us_citizen",
    date_of_birth: '1993-08-23',
    identification: {
      ssn: "0000"
    },
    address: {
      street1: "1 Infinite Loop",
      city: "Cupertino",
      state: "CA",
      postal_code: "95014",
      country_code: "US"
    },
    name: {
      first: "Alain",
      last: "Meier"
    }
}, callback);

Question Sets

Create a new question set

blockscore.questions.create(verification_id, callback);

Score a question set

var data = {
    verification_id: response.verification_id,
    question_set_id: response.question_set_id,
    answers: [
      {
        question_id: 1,
        answer_id: 1
      },
      {
        question_id: 2,
        answer_id: 1
      },
      {
        question_id: 3,
        answer_id: 1
      },
      {
        question_id: 4,
        answer_id: 1
      },
      {
        question_id: 5,
        answer_id: 1
      }
    ]
};
blockscore.questions.score(data, callback);

Contributing to BlockScore

  • 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.

Copyright (c) 2014 BlockScore. See LICENSE.txt for further details.

npm loves you