FAQs | API Developer Portal

1. How do I authenticate my requests to the encrypted version of the API?

Ans: Authentication methods can vary across APIs, commonly involving API keys or OAuth tokens. For the encrypted version of this API, authentication is done using header_secrets and a pass_key, which must be included in the request headers.

2. How will I receive the header_secrets and pass_key?

Ans: The header_secrets and pass_key will be shared with you separately via email by the ISU team.

3. What should I do if I encounter an error while using the API?

Ans: Errors may occur due to invalid input, authentication failures, or server issues. First, verify that your request is properly formatted and includes the correct authentication credentials. If the issue persists, please contact the iServeU support team for assistance.

4. How is secure data transmitted to and from the API?

Ans: iServeU ensures secure data transmission by using AES-256 encryption for both the request and response bodies. Additionally, encrypted headers (header_secrets) and a pass_key are used for authentication. It is essential to implement the encryption and decryption logic exactly as provided by iServeU to maintain security and compatibility.

5. What happens if consent-based Aadhaar verification fails? What are the common reasons for failure, and how can they be addressed?

Ans: Failure scenarios are detailed in the API documentation under the "Failure Cases" section. Please refer to that for specific reasons and recommended resolutions.

6. Can the API be used for e-KYC (Electronic Know Your Customer) purposes?

Ans: No, this API cannot be used for e-KYC. It provides an alternative consent-based method to verify a customer’s Aadhaar details using an OTP sent to the customer’s registered mobile number.