Jump to Content
REL-ID for Mobile
REL-ID APIs
REL-ID for Web
Guides
Recipes
Changelog
v25.04
v25.05
REL-ID for Mobile
REL-ID APIs
REL-ID for Web
Guides
v25.05
Guides
Recipes
Changelog
Creating a new session
Search
All
Pages
Start typing to search…
REL-ID for mobile
Setup
REL-ID SDK
Getting Started with REL-ID SDK
React Native
Flutter
Cordova
Native iOS
Native Android
Permissions for Android
Permissions for iOS
Callback based architecture
Register for REL-ID SDK Events
Initialize the REL-ID SDK
initialize
onInitializeProgress
onInitializeError
onInitialized
getUser
REL-ID IDV SDK
Set IDV Database
Get IDV Databases
Update IDV Configurations
React Native
Flutter
Cordova
Native iOS
Native Android
Get IDV Configurations
Localization
React Native
Flutter
Cordova
Native iOS
Native Android
Internationalization
React Native
Cordova
Native Android
Get Server configurations
Mobile Threat Detection
onUserConsentThreats
onTerminateWithThreats
Customization of MTD Threat Messages
Basic Challenges
What are Challenges
Challenge Modes
OTP
OTP ( Email and sms)
Email OTP
SMS OTP
QR Code Verification
Resend OTP
Password
Secret Question and Answer
onSelectSecretQuestionAnswer
getSecretAnswer
setSecretQuestionAnswer
IDV Challenges
Document Scan
getIDVDocumentScanProcessStartConfirmation
getIDVConfirmDocumentDetails
Sample OCR Data v3.0 JSON
Selfie Biometric Capture
getIDVSelfieProcessStartConfirmation
getIDVSelfieConfirmation
KYC Challenge
onIDVKYCProgress
Selfie Biometric Opt In Consent
getIDVBiometricOptInConsent
Selfie Biometric Authentication
initiateIDVServerBiometricAuthentication
onIDVServerBiometricAuthenticationResult
Custom Challenge
Prelogin User Workflows
User Onboarding
Self Enrollment
Agent based User Enrollment
Enroll User API
User Onboarding Challenges
Callback on Completetion of all Challenges
User Activation
Basic Workflow
IDV Workflow
Setting Device Name
activateUserOption
onDeviceActivated
Passwordless activation
Get User Consent For LDA
Login
onAuthenticationOptionsAvailable
onUserLoggedIn
Alternate Login Id
Post Login events called by SDK
Reset Authentication Flow
User Logoff
LogOff
Terminate SDK
Forgot Password
Forgot Login ID
Password Expiry
TOTP in Offline Mode
Additional Device Activation
Without REL-ID Verify flow
REL-ID Verify flow
addNewDeviceOptions
performVerifyAuth
fallbackNewDeviceActivationFlow
Unblock User Account
Postlogin User Workflows
Biometric Opt In
checkIDVUserBiometricTemplateStatus
initiateIDVBiometricOptIn
onIDVOptInCapturedFrameConfirmation
onIDVBiometricOptInStatus
Biometric Opt Out
Session Management
Creating a new session
Session Timeout Notification
Extend Session Timeout
Session Timeout
Token Management
Request New Token
onAccessTokenRefreshed
Update Device Details
Show Registered Devices
Post Login User KYC
initiateActivatedCustomerKYC
onIDVActivatedCustomerKYCResponse
initiateAgentKYCforUser
onIDVAgentKYCResponse
Updating any credential
getAllChallenges
onCredentialsAvailableForUpdate
initiateUpdateFlowForCredential
onUpdateCredentialResponse
updatePassword
LDA Toggling
LDA to Password
Password to LDA
getDeviceAuthenticationDetails
manageDeviceAuthenticationModes
onDeviceAuthManagementStatus
Additional Document Scan
initiateIDVAdditionalDocumentScan
onIDVAdditionalDocumentScan
Time based OTP (TOTP)
Registering for TOTP
TOTP in Online Mode
onTOTPRegistrationStatus
fetchRegisteredTOTPUsers
generateTOTP
getTOTPPassword
onTOTPGenerated
Data Signing
Account Blocking
Common Workflows
Tunneling in REL-ID
Discover Available services
Manage Access Tunnel
Make REST API calls
openHttpConnection
Data Encryption
getDefaultCipherSpec
getDefaultCipherSalt
Push Notifications
Push Notification Workflow
Common Push Notification concepts
Register Device for Push Notification
getDeviceToken
setDeviceToken
Token Registration
React Native
Cordova
iOS – ObjectiveC
Notification Management
Fetch Notifications
Acting on a notification
Stepup Authentication for Actions
View Notification history
SDK Debugging
Get Device ID
Missing Credentials for external service
REL-ID Agent
Get Security Threat Logs
Get SDK Logs
Get SDK Error Info
Get Session ID
Get SDK Version
RDNALoggingLevel Enum
Migration Guide
v25.03.06 to v25.04.06
Native SDK ( Android & iOS )
Secure Storage Handling Guidelines
REL-ID APIs
Getting Started with REL-ID APIs
Authentication & Token Management
Authorization Endpoint
Generate Access Token (Client Credentials)
Generate Access Token (Authorization Code)
Token Introspection
Revoke Access Token
User Info
JWKS Endpoint
User Activation
Account Recovery
Auth Server health check
Generate IdvWebToken
REL-ID Verify: Push Notifications
Authentication
Generate Notification
Generate Notification Request
Notification Callback
Secure Token Generation
OTP Controls
Check Notification Status
Cancel Notification
Configuring Limits
Validate OTP
User Management
Add User a.k.a Enroll User
Update User Status
Fetch User by UserId
Fetch userId by sessionId
Fetch User Devices
Fetch Authenticators of User
Set Predefined Code
Validate TOTP
KYC API
KYC API Request
Document fields
KYC API Endpoint
Configure REL-ID to Send KYC Requests
Configure KYC Flow in Gateway Console
Selfie Biometric Matching
REL-ID for Web
Overview
Enterprise APIs
IDV Web Flow Steps
Scan your Document
Confirm Document Details
Take Selfie
KYC
KYC Configuration
Otp-In
Redirect Back to Enterprise Portal
Configure Document Scan Structure
Access Token for GM-API Server
REL-ID Web Authentication
REL-ID Web Authentication Module
Key Features & Highlights
REL-ID Web Authentication Portal
User Authentication (aka User Login)
User Activation (Web Credential Activation)
User Portal (Security Settings)
Supported Authentication Factors
REL-ID verify based Push Notification
Time-based OTP in offline Mobile App
Password
SMS-based OTP
Email-based OTP
Management Console Configuration
Configuration: Allowed Authentication Factors
Configuration: Allowed Registration Factors
Configuration: Allowed IDV Methods
User Activation on Web (Web Credential Activation / Web-Only user activation)
Password Flow
Notes
Authentication Orchestration
Unrecognized Browser Flow
Recognized Browser Flow
Authentication steps / workflow diagram
Authentication Failure
Update Password on Expiry
Notes
User Portal (Security Settings)
Sign In Options
Updating Sign In Options
Update Password
Update Email
Update Mobile Number
Authentication Code in App and Push Notification
Remembered Browsers
Viewing browser information
Un-remember/Forget/Delete a browser
Account Recovery flows on web
Forgot Username
Pre-login flow
Don’t have access to the mobile app ?
Forgot Password
Partial-login flow
Don’t have access to the mobile app ?
Can’t access Email ?
Can’t access SMS ?
Account Recovery Link Action
Browser-based Account Recovery IDV Module (AR-IDV)
Step 1: Validate Access Code
Step 2: Determine IDV Method
Step 3: Use IDV Method
Browser-based Account Recovery Credential Activation (AR-C) Module
Internationalization
Steps to add a new language
Web Only User Activation and Account Recovery URLs
Notes
Integration
Client Onboarding
Registering OAuth2 Client
Getting Client Credentials (Client Id and Client Secret)
Integrating with OAuth2 flows
OpenID Connect (OIDC) flow
Client Credentials Flow
User Activation on Web (Web Credential Activation / Web-Only user activation)
Enrolling a user
Generating a token
Starting the Activation flow
Completing the Activation flow
(AR-IDV) Browser-based Account Recovery IDV
Configure Account Recovery Link
Starting the Browser-based Account Recovery IDV flow
Performing and Completing the Browser-based Account Recovery IDV flow
(AR-C) Browser-based Account Recovery Credential Activation
Generating a token
Starting the Browser-based Account Recovery Credential Activation flow
Completing the Browser-based Account Recovery Credential Activation flow
Web Authentication Module Configurations
Powered by
Creating a new session
Updated 3 months ago
Biometric Opt Out
Session Timeout Notification
