Auth key login
For AI agents: visit https://docs.payb.is/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Status page
GuidesRecipesAPI ReferenceChangelog
v4.1.12Status page
Guides
v4.1.12GuidesRecipesAPI ReferenceChangelog
Auth key login
About Paybis
Welcome to Paybis
Why Integrate with Usgetting started
Integration Process
Whitelabel SetupRamps
Fiat-to-Crypto On Ramp
Crypto-to-Fiat Off Ramp
Capabilities and Coverage
Supported Assets
Supported Countries
Payment Methods
Payout Methods
Ramps Integration Guides
Choosing the Right Integration Path
Platform Compatibility & Limitations
Web: API-Based Integration
Web: Standalone Integration
Generating HMAC Signatures
Web SDK
Embedded Mode
Standalone Integration Guide
Custom Frontend Integration: Technical Requirements
Internal Events
Helpful Tips
Mobile: iOS SDK
Mobile: Android SDK
Mobile: SDK Integration on Flutter Apps
Ramp SDK for React Native
Use cases
Frictionless Off-Ramping for Wallets
One-click checkout
One-click login and checkout via Apple Pay
Promo codes for buying/selling crypto
Customizing  User Journeys: Remove Any Friction
Supply user email and wallet
Single sign-on (SSO)
Reusable KYC (Shared KYC)
Set default payment method
Control transaction fiat, crypto and amount
Auth key login
Set payment method for Google Pay, Apple Pay, and Credit CardsCorporate ramps
Product Overview
Integration Guide
KYB Onboarding Guide
Supported Assets
Payment and Payout MethodsPaybis Send
Product Overview
Crypto Pay-outs Integration Guide
Fiat Pay-outs Integration Guide
Crypto Pay-ins Integration Guide
Partner Portal Overview
Send Crypto Payouts
Send Fiat Payouts
Transaction Overview
Capabilities and Coverage
Supported AssetsPartner portal
Product Overview
Left-side panel and Dashboard
Profile SettingsHElp and support
Partner support portalRAMP Integration for EMI
EMI Partner API Integration Guide
Powered by
Auth key login
The Auth key login feature of the Paybis API offers a straightforward and secure authentication solution tailored for non-custodial and web3 providers who prioritize privacy and usability.
⚙️
Prerequisites
Integration Type: Client-to-server API integration.
Receive confirmation from your Paybis integration manager that the Auth key login feature has been enabled for your partner account before implementing this feature.
Signing requests is mandatory.
Implement logic for generating and storing auth keys on per user basis.
How it Works
Partners use an auth key (a unique string value such as a UUID or private key, generated and managed internally) for user identification and authentication within the Paybis On/Off Ramp. This key should be included in the partnerUserId field of each transaction request associated with a specific customer.
Initial User Session: During the first session within the widget, the customer is prompted to enter and verify their email via OTP (One-Time Password).
Subsequent Sessions: For subsequent sessions, the partner should provide the correct auth key (partnerUserId) and set the passwordless flag to true. Assuming the email associated with the provided auth key exists within the Paybis system, Paybis generates a one-time token. This token can then be utilized by the partner as an additional URL parameter, facilitating automatic user authentication within the widget.
Integration Flow Steps
Auth Key Setup: Generate and securely store an auth key (e.g., UUID, private key associated with the given customer).
Ensure that the user has an active session in your app.
Call the server-to-server API endpoint POST /Private Request) with the  passwordless flag set to true andpartnerUserId (both are required) parameters.
New user (first session): The user undergoes standard authentication by providing their email and verifying it through OTP. Paybis establishes the association between the provided auth key and the customer's email address during this initial session.
Existing user (repeated session): Paybis system generates and returns the server-to-server POST /Private Request) endpoint response containing oneTimeToken along with the requestId.
Pass the retrieved oneTimeToken as an extra SDK parameter upon widget initialization or in query parameters if you are using the Direct URL Integration.
If the supplied oneTimeToken is valid, the customer associated with the email address linked to this key is automatically logged in to the widget. Consequently, the email verification step is bypassed in the widget journey.
⚠️
oneTimeToken expiration is 15 min.
Updated 8 months ago
Control transaction fiat, crypto and amount
Set payment method for Google Pay, Apple Pay, and Credit Cards
Did this page help you?
Yes
No
Copy Page
How it Works
Integration Flow Steps