Module: Passbase

Defined in:
lib/passbase/version.rb,
lib/passbase.rb,
lib/passbase/api_error.rb,
lib/passbase/api_client.rb,
lib/passbase/models/user.rb,
lib/passbase/configuration.rb,
lib/passbase/models/cursor.rb,
lib/passbase/api/project_api.rb,
lib/passbase/models/identity.rb,
lib/passbase/models/resource.rb,
lib/passbase/api/identity_api.rb,
lib/passbase/models/resource_file.rb,
lib/passbase/models/resource_input.rb,
lib/passbase/models/project_settings.rb,
lib/passbase/models/identity_resource.rb,
lib/passbase/models/watchlist_response.rb,
lib/passbase/models/paginated_resources.rb,
lib/passbase/models/paginated_identities.rb,
lib/passbase/models/project_settings_customizations.rb,
lib/passbase/models/project_settings_verification_steps.rb

Overview

#Verification API

## Introduction <span class="subtext"> Welcome to the Passbase Verifications API docs. This documentation will help you understand our models and the Verification API with its endpoints. Based on this you can build your own system (i.e. verification) and hook it up to Passbase. In case of feedback or questions you can reach us under this email address: [[email protected]]([email protected]). </span> A User submits a video selfie and valid identifying __Resources__ during a __Verification__ guided by the Passbase client-side integration. Once all the necessary __Resources__ are submitted, __Data points__ are extracted, digitized, and authenticated. These Data points then becomes part of the User’s __Identity__. The User then consents to share __Resources__ and/or __Data points__ from their Identity with you. This information is passed to you and can be used to make decisions about a User (e.g. activate account). This table below explains our terminology further. | Term | Description | |—————————————–|————-| | [Identity](#tag/identity_model) | A set of Data points and Resources related to and owned by one single User. This data can be accessed by you through a Verification. | | Data points | Any data about a User extracted from a Resource (E.g. Passport Number, or Age). | | [Resource](#tag/resource_model) | A source document used to generate the Data points for a User (E.g. Passport). | | [User](#tag/user_model) | The owner of an email address associated with an Identity. | | Verification | A transaction through which a User consents to share Data points with you. If the Data points you request are not already available in the User’s Identity, the Passbase client will ask the User to submit the necessary Resource required to extract them. | | Re-authentication (login) | A transaction through which a User can certify the ownership of Personal data previously shared through an Authentication. | # Authentication <span class="subtext"> There are two forms of authentication for the API: <br/>&bull; API Key <br/>&bull; Bearer JWT Token </span>

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech OpenAPI Generator version: 5.0.0-SNAPSHOT

Defined Under Namespace

Classes: ApiClient, ApiError, Configuration, Cursor, Identity, IdentityApi, IdentityResource, PaginatedIdentities, PaginatedResources, ProjectApi, ProjectSettings, ProjectSettingsCustomizations, ProjectSettingsVerificationSteps, Resource, ResourceFile, ResourceInput, User, WatchlistResponse

Constant Summary collapse

VERSION = 
'1.0.2'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Passbase.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



46
47
48
49
50
51
52
 
# File 'lib/passbase.rb', line 46

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end