mohdnazrul/laravel-ctos-ekyc

Library to pull and verify from eKYC CTOS (Version 1)


License
MIT

Documentation

CTOS eKYC API Package (Version 1)

This Library allows to query the CTOS eKYC - B2B API for registered users.

You need the access details that were provided to you to make any calls to the API. For exact parameters in the data array, refer to your offline documentation.

If you do not know what all this is about, then you probably do not need or want this library.

Configuration

.env file

Configuration via the .env file currently allows the following variables to be set:

  • CTOS_EKYC_URL='http://api.endpoint/url/'
  • CTOS_EKYC_CIPHER=EncryptionMethod (e.g: aes-256-cbc)
  • CTOS_EKYC_API_KEY=Contact Xendity/CTOS
  • CTOS_EKYC_CIPHER_TEXT=Contact Xendity/CTOS
  • CTOS_EKYC_PACKAGE_NAME=Contact Xendity/CTOS
  • CTOS_EKYC_MD5_KEY=Contact Xendity/CTOS

Available functions

FOR LARAVEL SETUP CONFIGURATION:-

  • Do composer require mohdnazrul/laravel-ctos-ekyc
   composer require mohdnazrul/laravel-ctos-ekyc
  • Add this syntax inside config/app.php
   ....
   'providers'=> [
     .
     MohdNazrul\CTOSEKYCLaravel\CTOSeKYCServiceProvider::class,
     .
   ],
   'aliases' => [
      .
      'CTOSEKYC' => MohdNazrul\CTOSEKYCLaravel\CTOSeKYCServiceProvider::class,
      '
    ],
  • Do publish as below
php artisan vendor:publish --tag=ctos_ekyc 
  • You can edit the default configuration eKYC CTOS inside config/ctos_ekyc.php based your account as below
return [
    'CTOS_EKYC_URL' => env('CTOS_EKYC_URL', 'http://localhost'),
    'CTOS_EKYC_CIPHER' => env('CTOS_EKYC_CIPHER', 'NA'),
    'CTOS_EKYC_API_KEY' => env('CTOS_EKYC_API_KEY', 'NA'),
    'CTOS_EKYC_CIPHER_TEXT' => env('CTOS_EKYC_CIPHER_TEXT', 'NA'),
    'CTOS_EKYC_PACKAGE_NAME' => env('CTOS_EKYC_PACKAGE_NAME', 'NA'),
    'CTOS_EKYC_MD5_KEY' => env('CTOS_EKYC_MD5_KEY', 'NA'),
];