devonzuegel/blockscore-node

An API wrapper for the BlockScore API using Node.js.

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({
	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.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);

Companies

List all companies

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

List 5 companies

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

View a company by ID

blockscore.companies.retrieve(company_id, callback);

Create a new company

blockscore.companies.create({
    "entity_name": "BlockScore",
    "tax_id": "123410000",
    "incorp_date": "1980-08-25",
    "incorp_state": "DE",
    "incorp_country_code": "US",
    "incorp_type": "corporation",
    "dbas": "BitRemit",
    "registration_number": "123123123",
    "email": "[email protected]",
    "url": "https://blockscore.com",
    "phone_number": "6505555555",
    "ip_address": "67.160.8.182",
    "address": {
      "street1": "123 Fake Streets",
      "street2": null,
      "city": "Stanford",
      "state": "CA",
      "postal_code": "94305",
      "country_code": "US"
    },
    "details": {
      "entity_name": "match",
      "tax_id": "match",
      "ofac": "no_match"
    }
}, callback);

Watchlist Candidates

List all watchlist candidates

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

List 3 watchlist candidates

blockscore.watchlist_candidates.list({
  count: 3
}, callback);

View a watchlist candidate by ID

blockscore.watchlist_candidates.retrieve(watchlist_candidate_id, callback);

Create a new watchlist candidate

blockscore.watchlist_candidates.create({
	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);

Update a watchlist candidate

Only the information you send us will be updated - the rest will remain the same.

blockscore.watchlist_candidates.update(watchlist_candidate.id, {
	address_state:'CA', 
}, callback);

View a watchlist candidate's past hits

blockscore.watchlist_candidates.hits(watchlist_candidate.id, callback);

Delete a watchlist candidate from scan list

blockscore.watchlist_candidates.del(watchlist_candidate.id, callback);

View a watchlist candidate's revision history

blockscore.watchlist_candidates.history(watchlist_candidate.id, callback);

Watchlists

Search watchlists

Creates a new verification, runs it through our verification process, and returns a list of all associated matches.

blockscore.watchlists.search({
	watchlist_candidate_id: id,  // required
	match_type: type  // optional
}, 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

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