pankajkeswani/ost-kyc-sdk-php

OST KYC SDK PHP

The official OST KYC PHP SDK.

Requirements

To use this module, developers will need to:

1. Login on https://kyc.ost.com/admin/login.
2. Obtain an API Key and API Secret from https://kyc.ost.com/admin/settings/developer-integrations.

Documentation

https://dev.ost.com/docs/kyc/index.html

Installation

Install Composer:

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

Install the latest stable version of the SDK:

> php composer.phar require ostdotcom/ost-kyc-sdk-php

Example Usage

Require the Composer autoloader:

require 'vendor/autoload.php';

Initialize the SDK object:

$params = array();
$params['apiKey']=API_KEY;
$params['apiSecret']=API_SECRET;
$params['apiBaseUrl']='https://kyc.ost.com';

// The config field is optional for $ostKycSdkObj Object
$nestedparams = array();
// This is the timeout in seconds for which the socket connection will remain open
$nestedparams["timeout"] = 15;
$params["config"] = $nestedparams;

$ostKycSdkObj = new OSTKYCSDK($params);

Users Module

$userService = $ostKycSdkObj->services->user;

Create a new user:

$params = array();
$params['email'] = 'email@domain.com';
$response = $userService->create($params)->wait();
var_dump($response);

Get an existing user:

$params = array();
$params['id'] = '11007';
$response = $userService->get($params)->wait();
var_dump($response);

Get a list of users and other data:

$params = array();
$response = $userService->getList($params)->wait();
var_dump($response);

Users Kyc Module

$usersKycService = $ostKycSdkObj->services->usersKyc;

Create/update kyc:

$params = array();
$params['user_id'] = "11035";
$params['first_name'] = "aniket";
$params['last_name'] = "ayachit";
$params['birthdate'] = "21/12/1991";
$params['country'] = "india";
$params['nationality'] = "indian";
$params['document_id_number'] = "arqpa7659a";
$params['document_id_file_path'] = "2/i/016be96da275031de2787b57c99f1471";
$params['selfie_file_path'] = "2/i/9e8d3a5a7a58f0f1be50b7876521aebc";
$params['residence_proof_file_path'] = "2/i/4ed790b2d525f4c7b30fbff5cb7bbbdb";
$params['ethereum_address'] = "0xdfbc84ccac430f2c0455c437adf417095d7ad68e";
$params['postal_code'] = "afawfveav";
$params['investor_proof_files_path'] = array("2/i/9ff6374909897ca507ba3077ee8587da", "2/i/4872730399670c6d554ab3821d63ebce");
$response = $usersKycService->submit_kyc($params)->wait();
var_dump($response);

Send Approve Email to User:

$params = array();
$params['user_id'] = "11550";
$response = $usersKycService->email_approve($params)->wait();
var_dump($response);

Send Deny Email to User:

$params = array();
$params['user_id'] = "11550";
$response = $usersKycService->email_deny($params)->wait();
var_dump($response);

Send Report Issue Email to User:

$params = array();
$params['user_id'] = "11550";
$response = $usersKycService->email_report_issue($params)->wait();
var_dump($response);

get an existing users kyc:

$params = array();
$params['user_id'] = '11007';
$response = $usersKycService->get($params)->wait();
var_dump($response);

Get a list of existing users kyc and other data:

$params = array();
$response = $usersKycService->getList($params)->wait();
var_dump($response);

Get presigned urls for put call:

$params = array();
$nestedparams = array();
$nestedparams['selfie'] = 'image/jpeg';
$nestedparams['document_id'] = 'image/jpeg';
$params['files'] = $nestedparams;
$response = $usersKycService->get_presigned_url_put($params)->wait();
var_dump($response);

Get presigned urls for post call:

$params = array();
$nestedparams = array();
$nestedparams['selfie'] = 'image/jpeg';
$nestedparams['document_id'] = 'image/jpeg';
$params['files'] = $nestedparams;
$response1 = $usersKycService->get_presigned_url_post($params)->wait();
var_dump($response1);

Users Kyc Detail Module

$usersKycDetailService = $ostKycSdkObj->services->usersKycDetail;

get an existing users kyc detail:

$params = array();
$params['user_id'] = '11007';
$response = $usersKycDetailService->get($params)->wait();
var_dump($response);

Validators Module

$validatorsService = $ostKycSdkObj->services->validators;

verify ethereum address:

$params = array();
$params['ethereum_address'] = '0x7f2ED21D1702057C7d9f163cB7e5458FA2B6B7c4';
$response = $validatorsService->verify_ethereum_address($params)->wait();
var_dump($response);