/ 
Experian-IDAuth-2.1
River stage zero No dependents
/ Experian::IDAuth

NAME

Experian::IDAuth - Experian's ID Authenticate service

VERSION

Version 2.1

DESCRIPTION

This module provides an interface to Experian's Identity Authenticate service. http://www.experian.co.uk/identity-and-fraud/products/authenticate.html

First create a subclass of this module to override the defaults method with your own data.

package My::Experian;
use strict;
use warnings;
use base 'Experian::IDAuth';

# if you're using a logger
use Log::Log4perl;

sub defaults {
    my $self = shift;

    return (
        $self->SUPER::defaults,
        logger        => Log::Log4perl::get_logger,
        username      => 'my_user',
        password      => 'my_pass',
        residence     => $residence,
        postcode      => $postcode || '',
        date_of_birth => $date_of_birth || '',
        first_name    => $first_name || '',
        last_name     => $last_name || '',
        phone         => $phone || '',
        email         => $email || '',
    );
}

1;

Then use this module.

use My::Experian;

# search_option can either be ProveID_KYC or CheckID
my $prove_id = My::Experian->new(
    search_option => 'ProveID_KYC',
);

my $prove_id_result = $prove_id->get_result();

if (!$prove_id->has_done_request) {
    # connection problems
    die;
}

if ($prove_id_result->{age_verified}) {
    # client's age is verified
}
if ($prove_id_result->{deceased} || $prove_id_result->{fraud}) {
    # client flagged as deceased or fraud
}
if ($prove_id_result->{deny}) {
    # client on any of PEP, OFAC, or BOE list
    # you can check $prove_id_result->{PEP} etc if you want more detail
}
if ($prove_id_result->{fully_authenticated}) {
    # client successfully authenticated, 
    # DOES NOT MEAN NO CONCERNS

    # check number of credit verifications done
    print "Number of credit verifications: " . $prove_id_result->{num_verifications} . "\n";
}

# CheckID is a more simpler version and can be used if ProveID_KYC fails
my $check_id = My::Experian->new(
    search_option => 'CheckID',
);

if (!$check_id->has_done_request) {
    # connection problems
    die;
}

if ($check_id->get_result()) {
    # client successfully authenticated
}

METHODS

new()

Creates a new object of your derived class. The parent class should contain most of the attributes required for new(). But you can set search_option to either ProveID_KYC or CheckID

get_result()

Return the Experian results as a hashref

save_pdf_result()

Save the Experian credentials as a PDF

AUTHOR

binary.com, perl at binary.com

BUGS

Please report any bugs or feature requests to bug-experian-idauth at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Experian-IDAuth. We will be notified, and then you'll automatically be notified of progress on your bug as we make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Experian::IDAuth

You can also look for information at:

DEPENDENCIES

Locale::Country
Path::Tiny
WWW::Mechanize
XML::Simple
XML::Twig
SOAP::Lite
IO::Socket

LICENSE AND COPYRIGHT

Copyright 2014,2015 binary.com.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.