Api

Comprobo\Verify\Api is the public API for the Verify SDK. All public methods should be considered normal operation of the SDK. It is possible to retrieve individual objects and make calls directly to different services although this should not be a requirement for normal usage. USAGE: $verify = Comprobo\Verify\Api::create(); $verify->authenticate($key, $secret); ...
Open source code
Methods Summary
public static
# create( string $env = 'production', array $config = array ( ) )
Bootstrap the Verify API. Custom configuration options are currently not supported.
public
# __construct( Comprobo\Verify\Factory $factory )
Used by the factory itself. If you happen to need to instantiate the API this way then you can.
public
# javascriptPath( )
Helper method to provide javascript asset location.
public
# cssPath( )
Helper method to provide css asset location.
public
# authenticate( $key , $secret )
Use your application key and secret to set JWT token and organisation ID in the current API context After this is called, you may continue to use the rest of the API methods provided here.
public
# link( string $templateId , string $monitorableId , string $friendlyName , array $customFields = array ( ) )
Clones the selected template to create an assignable Workflow instance. Any custom fields provided are persisted at this stage and may not be changed.
public
# templates( )
List the available templates for monitoring, used for configuration
public
# begin( string $userId , string $monitorableId )
Provides a user access token and internal IDs for booting the Verify JavaScript SDK. Once this has been called against a `link`ed template, that template cannot be modified but may be replaced by a new call to `link`

see

self::link
public
# createUser( string $userId , string $firstName , string $lastName , string $email = NULL )
Create a user account to run the verify instance under. Normally this will be per-user of your system. *
public
# setReferencePhoto( string $userId , array $file )
Upload reference photo Normally this will be per-user of your system, upload a file into comprobo to use as a reference image for facial comparison
Constants Summary
public string DEFAULT_ENV
# 'production'