README.md

passbase

Passbase - the Ruby gem for the Verification API

Introduction

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.3.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build passbase.gemspec

Then either install the gem locally:

gem install ./passbase-1.3.0.gem

(for development, run gem install --dev ./passbase-1.3.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'passbase', '~> 1.3.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/passbase/passbase-ruby, then add the following in the Gemfile:

gem 'passbase', :git => 'https://github.com/passbase/passbase-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'passbase'

# Setup authorization
Passbase.configure do |config|
  # Configure API key authorization: SecretApiKey
  config.api_key['SecretApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['SecretApiKey'] = 'Bearer'
end

api_instance = Passbase::IdentityApi.new
id = TODO # String | Unique ID of the identity to return

begin
  #Get identity
  result = api_instance.get_identity_by_id(id)
  p result
rescue Passbase::ApiError => e
  puts "Exception when calling IdentityApi->get_identity_by_id: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.passbase.com/verification/v2

Class	Method	HTTP request	Description
Passbase::IdentityApi	get_identity_by_id	GET /identities/{id}	Get identity
Passbase::IdentityApi	get_identity_resource_by_id	GET /identity/{id}/resources/{resource_id}	Get resource
Passbase::IdentityApi	get_identity_resource_file_by_id	GET /identity/{id}/resources/{resource_id}/resource_files/{resource_file_id}	Get resource file
Passbase::IdentityApi	list_identities	GET /identities	List identities
Passbase::IdentityApi	list_identity_resources	GET /identity/{id}/resources	List resources
Passbase::ProjectApi	get_settings	GET /settings	Get project settings

Documentation for Models

• Passbase::Cursor
• Passbase::Identity
• Passbase::IdentityOwner
• Passbase::IdentityResource
• Passbase::PaginatedIdentities
• Passbase::PaginatedResources
• Passbase::ProjectSettings
• Passbase::ProjectSettingsCustomizations
• Passbase::ProjectSettingsVerificationSteps
• Passbase::Resource
• Passbase::ResourceFile
• Passbase::ResourceInput
• Passbase::User
• Passbase::WatchlistResponse

Documentation for Authorization

IdentityAccessToken

• Type: Bearer authentication (JWT)

PublishableApiKey

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

SecretApiKey

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header