BlockScore Codeigniter Library

BlockScore provides a fast and accurate identity verification API. Implement knowledge-based authentication and verification in minutes and start verifying your customers.

The documentation of the API can be found at https://manage.blockscore.com/docs/index

Install

To install the BlockScore CodeIgniter Library, you need composer first:

curl -sS https://getcomposer.org/installer | php

Edit composer.json:

{
    "require": {
        "roncodes/ci-blockscore-lib": "1.*"
    }
}

Install the depencies by executing composer:

php composer.phar install

Usage

Get verification on identity:

$this->load->library('BlockScore');
$person = array(
    'type' => 'us_citizen', // or international_citizen
    'date_of_birth' => '1990-12-28',
    'name' => array(
        'first' => 'John',
        'middle' => 'Don',
        'last' => 'Doe'
    ),
    'address' => array(
        'street1' => '123 Abc St.',
        'street2' => 'Apt #123',
        'city' => 'Seattle',
        'state' => 'WA',
        'postal_code' => '98116',
        'country' => 'US'
    ),
    'identification' => array(
        'ssn' => '0000' 
    ) // or for international array('passport' => 'XXXXXXX', 'gender' => 'male')
);
$this->blockscore->verification($person);

Response:

array (size=10)
  'id' => string '530539413066370002560000' (length=24)
  'created_at' => int 1392851265
  'updated_at' => int 1392851265
  'type' => string 'us_citizen' (length=10)
  'status' => string 'valid' (length=5)
  'livemode' => boolean false
  'date_of_birth' => string '1990-12-28' (length=10)
  'identification' => 
    array (size=1)
      'ssn' => string '0000' (length=4)
  'name' => 
    array (size=3)
      'first' => string 'John' (length=4)
      'middle' => string 'Don' (length=3)
      'last' => string 'Doe' (length=3)
  'address' => 
    array (size=6)
      'street1' => string '123 Abc St.' (length=11)
      'street2' => string 'Apt #123' (length=8)
      'city' => string 'Seattle' (length=7)
      'state' => string 'WA' (length=2)
      'postal_code' => string '98116' (length=5)
      'country' => string 'US' (length=2)

Get questions for verification:

$this->load->library('BlockScore');
$verification_id = '530539413066370002560000';
$this->blockscore->questions($verification_id);

Result:

array (size=3)
  'verification_id' => string '530539413066370002560000' (length=24)
  'question_set_id' => string '5305a6243066370002770000' (length=24)
  'questions' => 
    array (size=5)
      0 => 
        array (size=3)
          'question' => string 'What state was your SSN issued in?' (length=34)
          'id' => int 1
          'answers' => 
            array (size=5)
              0 => 
                array (size=2)
                  'answer' => string 'Utah' (length=4)
                  'answer_id' => int 1
              1 => 
                array (size=2)
                  'answer' => string 'New Hampshire' (length=13)
                  'answer_id' => null
              2 => 
                array (size=2)
                  'answer' => string 'Delaware' (length=8)
                  'answer_id' => int 3
              3 => 
                array (size=2)
                  'answer' => string 'Oklahoma' (length=8)
                  'answer_id' => int 4
              4 => 
                array (size=2)
                  'answer' => string 'None Of The Above' (length=17)
                  'answer_id' => int 5
      // 4 more questions in the format above

Get score from users input:

$this->load->library('BlockScore');
$user_input = '{
   "verification_id":"530539413066370002560000",
   "question_set_id":"5305a6243066370002770000",
   "answers":[
      {
         "question_id":"1",
         "answer_id":""
      },
      {
         "question_id":"2",
         "answer_id":""
      },
      {
         "question_id":"3",
         "answer_id":""
      },
      {
         "question_id":"4",
         "answer_id":""
      },
      {
         "question_id":"5",
         "answer_id":""
      }
   ]
}';
$this->blockscore->score($user_input);

Result:

array (size=2)
  'question_set_id' => string '5305a6243066370002770000' (length=24)
  'score' => float 0

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.