Onboarding Flow
1
Register Your Application
Start by registering your application in the sandbox environment:
Sample Request
Sample Request
Username is unique, once taken cannot be re-used.
Sandbox Environment Sample Response
In sandbox, you’ll receive immediate approval with full credentials:Sample Response
Sample Response
Production Environment Sample Response
In production, you’ll receive a pending approval status with a registration token:Sample Response
Sample Response
After approval, use the username/password basic authorization to retrieve your credentials via the Get Client Credentials (GET
/dcr) endpoint.2
3
4
Test API Endpoints
Once you have an access token, test various API endpoints:
Sample Request
Sample Request
Next Steps
- ✅ Build your application
- ✅ Move to production
Moving to Production
Once you’ve thoroughly tested in sandbox:- Register in Production: Use the same application details
- Wait for Approval: Production registration requires review (24-48 hours). You will be informed once successfully registered. Alternative you can use the Get Client Credetnials API to get your client credentials
- Update Configuration: Switch to production endpoints
- Test Again: Verify everything works in production
- Go Live: Deploy your application
Always test thoroughly in sandbox before moving to production. The sandbox environment is designed to catch issues early and prevent problems in production.