telvri-ruby

Official Ruby SDK for the Telvri Security API — real-time SIM-swap and mobile identity risk checks for login recovery, payouts, and wallet protection.

Install

From GitHub (works now)

In your Gemfile:

gem 'telvri_security', git: 'https://github.com/Granville-Christopher/telvri-ruby', tag: 'v1.0.0'

Then:

bundle install

Requires Ruby 2.7+.

RubyGems (after publish)

gem install telvri_security

Or in your Gemfile:

gem 'telvri_security', '~> 1.0.0'

Quick start — SIM-swap check

require 'telvri_security'

TelvriSecurity.configure do |config|
  config.api_key['X-API-Key'] = ENV.fetch('TELVRI_API_KEY')
end

api = TelvriSecurity::SIMSwapIntelligenceApi.new
dto = TelvriSecurity::CheckSimSwapDto.new(
  phone_number: '+2348031234569',
  max_age_hours: 24
)

result = api.sim_swap_controller_check_sim_swap(dto)

puts "swapped=#{result.swapped} provider=#{result.provider} operator=#{result.operator}"

Set your key first:

export TELVRI_API_KEY=rt_live_your_api_key

API reference

All URIs are relative to https://telvrisecurity.vercel.app.

Class	Method	HTTP request	Description
SIMSwapIntelligenceApi	sim_swap_controller_check_sim_swap	POST /v1/security/sim-check	Run a real-time SIM-swap risk check
DeveloperAuthApi	auth_controller_login	POST /auth/login	Authenticate a developer account
DeveloperAuthApi	auth_controller_signup	POST /auth/signup	Create a developer account

Models

• CheckSimSwapDto
• SimSwapResponseDto
• LoginDto
• SignupDto

Full per-method and per-model docs are in the docs/ folder.

Development

This SDK is generated from the Telvri Security OpenAPI contract using OpenAPI Generator. To regenerate from the API project:

npm run sdk:fetch-spec
npm run sdk:generate:ruby

• API version: 1.0
• Gem version: 1.0.0
• Gem name: telvri_security
• Module: TelvriSecurity

License

MIT — see LICENSE.