Requests

Requests API Category

Overview

The Requests category encompasses a suite of APIs designed for customer identity verification and authentication. These APIs enable secure validation of various identity documents and implement two-factor authentication through OTP mechanisms. This category serves as the foundation for KYC (Know Your Customer) processes, helping businesses verify customer identities while maintaining regulatory compliance and enhancing security.

Category Details

Parent Category: Root/Customer
Child Categories: None
APIs in this category: Generate OTP v2, Submit OTP v2, PAN, Voter ID, License, Aadhaar Validation

Key Capabilities

Main Functionality

This category provides comprehensive identity verification capabilities through document validation and secure authentication mechanisms, allowing businesses to verify customer identities with confidence while maintaining compliance with regulatory requirements.

Two-Factor Authentication

Secure customer verification through OTP generation and validation, providing an additional layer of security for sensitive operations.

Document Verification

Validation of multiple government-issued identity documents including PAN, Voter ID, Driver's License, and Aadhaar, ensuring authentic customer identities.

Seamless KYC Integration

Streamlined integration with existing KYC workflows, allowing businesses to implement robust identity verification with minimal development effort.

Common Use Cases

Financial Services

E-commerce

Government Services

Customer onboarding for banking and financial applications

Verification before processing high-value transactions

Regulatory compliance for financial institutions

Integration Considerations

Best Practices

Always include the required X-Customer-Id header in all requests

Implement proper error handling for validation failures

Store verification results securely and in compliance with data protection regulations

Consider implementing rate limiting to prevent abuse

Important Limitations

Document verification APIs require clear, legible images of identity documents

OTP verification has time limitations; tokens typically expire after a short period

Some identity verification processes may have regulatory restrictions based on geography

Proper consent must be obtained from users before collecting and processing their identity information

How APIs in this Category Work Together

The APIs in this category are designed to work in sequence, creating a comprehensive identity verification workflow. They can be combined to implement multi-factor and multi-document verification processes that enhance security while maintaining a smooth user experience.

Key Integration Patterns:

Generate OTP v2 + Submit OTP v2: Creates a complete two-factor authentication flow for secure user verification

PAN + Aadhaar Validation: Provides dual document verification for high-assurance identity confirmation

Generate OTP v2 + License: Combines possession factor (OTP) with document verification for enhanced security

A typical end-to-end workflow might begin with generating an OTP to verify the customer's phone number or email, followed by submission and validation of that OTP, and then proceeding to document verification using one or more of the document validation APIs. This layered approach ensures both possession (of a device) and identity (through documents) are verified, significantly reducing fraud risks.

The Requests category serves as a foundational component within the broader Customer identity ecosystem. It works in conjunction with other categories to enable comprehensive customer management, onboarding, and security processes.

Related Categories include:

Customer Management: Builds upon verified identities to manage customer profiles and relationships

Risk Assessment: Uses verified identity information to evaluate customer risk profiles

Compliance Reporting: Leverages identity verification data for regulatory reporting requirements

The Requests category typically initiates customer journeys, with successful verification enabling subsequent processes in related categories. For example, after identity verification through the Requests APIs, applications can proceed with customer onboarding workflows, risk scoring, or account provisioning processes defined in other API categories.

Request Header

Key	Format	Description
X-Customer-Id	String	Customer ID generated from init request.

Overview#

Key Capabilities#

Common Use Cases#

Integration Considerations#

How APIs in this Category Work Together#

Related Categories#

Request Header#

Overview

Key Capabilities

Common Use Cases

Integration Considerations

How APIs in this Category Work Together

Related Categories

Request Header