Overview

Namespaces

  • Comprobo
    • Verify
      • Auth
      • Exceptions
      • HTTP

Classes

  • Api
  • Factory
  • State
  • User
  • Workflow
  • Overview
  • Namespace
  • Class

Class User

User service integration

Namespace: Comprobo\Verify
Located at User.php
Methods summary
public
# __construct( Comprobo\Verify\Factory $factory )
public array
# create( string $userId, string $firstName, string $lastName, string $email = null )

Create a new user in Comprobo. This user will not be given a direct login of their own, but must be impersonated to be used.

Create a new user in Comprobo. This user will not be given a direct login of their own, but must be impersonated to be used.

Parameters

$userId
the local ID you would like to be associated with this user.
$firstName
assigned to the user account and may be displayed in reports or other feedback.
$lastName
assigned to the user account and may be displayed in reports or other feedback.
$email
assigned to the user account and may be displayed in reports or other feedback.

Returns

array

the service response. Responsibilty falls on the caller to validate and extract relevant information

Throws

Comprobo\Verify\Exceptions\Auth
if the state is invalid

See

Comprobo\Verify\Api::impersonate method to impersonate a user when we have their unique ID.
public
# setReferencePhoto( string $userId, array $file )

Store an uploaded file against the given user to be used in monitoring as a reference photograph

Store an uploaded file against the given user to be used in monitoring as a reference photograph

Parameters

$userId
Your user id, as specified in the create call
$file
matching the $_FILES['my-file'] format, an array representing a file.

Throws

Comprobo\Verify\Exceptions\Upload
if the file is empty or an upload error has occurred.
API documentation generated by ApiGen