mlverify/php-sdk

PHP Library from SwaggerHub, for use with MLVerify.com

v1.0.0 2019-01-24 22:41 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors

• php
• api
• sdk
• swagger
• aml
• kyc
• mlverify

README

A simple collection of API commands to use the ML Verify API.

This PHP package has been automatically generated by the Swagger Codegen project:

• API version: v1

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, run the following command in your terminal:

composer require mlverify/php-sdk

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basic
$config = MLVerify\Client\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new MLVerify\Client\Api\AccountApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->accountWhoAmI();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountApi->accountWhoAmI: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.mlverify.com

Class	Method	HTTP request	Description
AccountApi	accountWhoAmI	GET /me	Gets current account data
ClientsApi	clientsDelete	DELETE /clients/{id}	Deletes client
ClientsApi	clientsGet	GET /clients/{id}	Gets client by id
ClientsApi	clientsGetAll	GET /clients	Gets clients by search criteria
ClientsApi	clientsPost	POST /clients	Creates client
ClientsApi	clientsPut	POST /clients/{id}	Updates client
ClientsApi	clientsSendKycCheck	POST /clients/{id}/sendkyc	Sends client access request
ConfigApi	configClientTypes	GET /config/client_types	Gets all client types
ConfigApi	configCountries	GET /config/countries	Gets all countries
ConfigApi	configNationalities	GET /config/nationalities	Gets all nationalities
ConfigApi	configRelationships	GET /config/relationships	Gets all relationships
IdChecksApi	idChecksCheck	POST /idchecks	Check person ID
KycCheckBundlesApi	kycCheckBundlesCreateChecks	POST /kycbundle/{id}	Create the bundle of KYC checks
KycCheckBundlesApi	kycCheckBundlesListKycCheckBundlesOfAccount	GET /kycbundle	Gets KYC check bundles of the account
KycChecksApi	kycChecksDelete	DELETE /kyc/{id}	Deletes KYC check
KycChecksApi	kycChecksGet	GET /kyc/{id}	Gets KYC check by id
KycChecksApi	kycChecksGetAll	GET /kyc	Gets KYC checks by search criteria
KycChecksApi	kycChecksPost	POST /kyc	Creates KYC check
KycChecksApi	kycChecksPut	POST /kyc/{id}	Updates KYC check
KycChecksApi	kycChecksRespond	POST /kyc/{id}/respond	Updates KYC check response
PersonsApi	personsDelete	DELETE /persons/{id}	Deletes person
PersonsApi	personsGet	GET /persons/{id}	Gets person by id
PersonsApi	personsGetAll	GET /persons	Gets persons by search criteria
PersonsApi	personsPost	POST /persons	Creates person
PersonsApi	personsPut	POST /persons/{id}	Updates person

Documentation For Models

• AccountKycCheckBundleModel
• AccountKycCheckBundlesModel
• AddressModel
• ClientCreateModel
• ClientModel
• ClientSearchQuery
• ClientUpdateModel
• CreateChecksModel
• CreateChecksResponceModel
• IdChecksCheckModel
• KycCheckCreateModel
• KycCheckModel
• KycCheckSendModel
• KycCheckUpdateModel
• PersonCreateModel
• PersonModel
• PersonSearchQuery
• PersonUpdateModel
• WhoAmIModel

Documentation For Authorization

basic

• Type: HTTP basic authentication

Author