README

A simple laravel package for Experian B2B Web Service.

Installation

You can install the package via composer:

composer require laraditz/experian

Before Start

Configure your variables in your .env (recommended) or you can publish the config file and change it there.

EXPERIAN_VENDOR=<vendor>
EXPERIAN_USERNAME=<username>
EXPERIAN_PASSWORD=<password>

(Optional) You can publish the config file via this command:

php artisan vendor:publish --provider="Laraditz\Experian\ExperianServiceProvider" --tag="config"

Run the migration command to create the necessary database table.

php artisan migrate

Available Methods

Below are all methods available under this package.

ccrisSearch(string $name, string $id, string $dob, ?string $country, ?string $id2, ?string $phone, ?string $email, ?string $address)
- At least one of phone, email, address must be present.
- id argument is for New IC or Passport No.
- id2 argument is for old IC or Poice ID.
- IC format XXXXXX-XX-XXXX.
- dob format YYYY-MM-DD.
- country default to MY.
checkProcessingReport(string $refNo)
getRecord(string $refNo)

Usage

Search CCRIS

// Using service container
$experian = app('experian')->ccrisSearch(
            name: "Ali bin Ahmad",
            id: "92XXXX-XX-XXXX",
            dob: "YYYY-MM-DD",
            phone: "012XXXXXXX" 
        );  

// Using facade
$experian = \Experian::ccrisSearch(
            name: "Ali bin Ahmad",
            id: "92XXXX-XX-XXXX",
            dob: "YYYY-MM-DD",
            phone: "012XXXXXXX" 
        );

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email raditzfarhan@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.

laraditz / experian

Maintainers

Details