Integration Guides

Step 1: Register and Get API Keys

1. Create a developer account on the registration page.
2. Verify your email and complete your organization profile.
3. Navigate to the API Keys section in your dashboard.
4. Generate a new API key for your application.
5. Store your API key securely (it will only be shown once).

Step 2: Choose Your Integration Method

Step 3: Implement Authentication Flow

The basic authentication flow consists of two main steps:

1. Initiate OTP: Send the user's Fayda Card Number (FCN) to request an OTP.
   text

   Copy code

   POST /api/fayda/otp/initiate

2. Verify OTP: Send the OTP, transaction ID, and FCN to verify the user.
   text

   Copy code

   POST /api/fayda/otp/verify

Step 4: Test Your Integration

1. Use the sandbox environment for testing: https://fayda-auth.vercel.app
2. Test with the provided test FCNs from your dashboard.
3. Use 123456 as the OTP code in the sandbox.
4. Test error scenarios and implement proper error handling.

Step 5: Go Live

1. Switch to the production API endpoint: https://fayda-auth.vercel.app
2. Use your production API key.
3. Monitor your API usage and set up alerts.