Skip to main content

Official Telvri Security SDK for SIM-swap and mobile identity checks.

Project description

telvri-security

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

Install

pip install telvri-security

Requires Python 3.9+.

Quick start — SIM-swap check

Run a SIM-swap risk check before a sensitive action. Authenticate with your rt_live_ API key.

import os
import telvri_security
from telvri_security.models.check_sim_swap_dto import CheckSimSwapDto
from telvri_security.rest import ApiException

configuration = telvri_security.Configuration(
    host="https://telvrisecurity.vercel.app",
)
configuration.api_key["X-API-Key"] = os.environ["TELVRI_API_KEY"]

with telvri_security.ApiClient(configuration) as api_client:
    api = telvri_security.SIMSwapIntelligenceApi(api_client)

    try:
        result = api.sim_swap_controller_check_sim_swap(
            CheckSimSwapDto(phoneNumber="+2348031234569", maxAgeHours=24),
        )
        print(result)
    except ApiException as error:
        # 400 = invalid request body, 401 = missing/invalid API key
        print(f"SIM-swap check failed: {error}")

The response looks like:

SimSwapResponseDto(
    phone_number="+2348031234569",
    swapped=False,
    last_swapped_at="2026-07-14T16:27:00.000Z",
    provider="MTN Nigeria",
    operator="MTN Nigeria",
)

Use the decision to gate the flow:

if result.swapped:
    ...  # Step up verification or block the action
else:
    ...  # Allow the recovery / payout / withdrawal

Authentication

The API accepts either an API key header or a bearer token.

# Option A: X-API-Key header (recommended)
configuration = telvri_security.Configuration(host="https://telvrisecurity.vercel.app")
configuration.api_key["X-API-Key"] = os.environ["TELVRI_API_KEY"]

# Option B: Authorization: Bearer <KEY>
configuration = telvri_security.Configuration(
    host="https://telvrisecurity.vercel.app",
    access_token=os.environ["TELVRI_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, run npm run sdk:generate in the main repository.

  • API version: 1.0
  • Package version: 1.0.0

License

UNLICENSED — © Telvri Security.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

telvri_security-1.0.0.tar.gz (26.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

telvri_security-1.0.0-py3-none-any.whl (32.5 kB view details)

Uploaded Python 3

File details

Details for the file telvri_security-1.0.0.tar.gz.

File metadata

  • Download URL: telvri_security-1.0.0.tar.gz
  • Upload date:
  • Size: 26.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for telvri_security-1.0.0.tar.gz
Algorithm Hash digest
SHA256 89201a1ff38a26991ffc0d63e4280d4228c6f1693dcd6c69ab23e616c1a4f847
MD5 7c8777f16407047556a145e6cd8f5077
BLAKE2b-256 db03675bb7dfc573e800ea0f692194b65158439c5e77b98a58f4030ca805017d

See more details on using hashes here.

File details

Details for the file telvri_security-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for telvri_security-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 672b3cf861fe3df64310a0c25fafcad754259a81c22d573f9f8aaa311c01e52e
MD5 a77504c4f8fed56dfc0cb4a32a8fa48f
BLAKE2b-256 437041cc323c6fac872d853f26caa470e2dd97a7ec5e4e9a0a2ee1d05ec0680e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page